From cb023ea4cc4dffe9cdcbfc3f98b66e194121e483 Mon Sep 17 00:00:00 2001 From: Anthony Martin Date: Thu, 26 Sep 2019 18:21:41 -0700 Subject: [PATCH] Regenerate expected schemas --- .gulp/common.iced | 46 +- .gulp/regeneration.iced | 79 +- package.json | 4 +- .../Microsoft.AnalysisServices.json | 150 - .../AnalysisServices/2016-05-16/servers.md | 66 - .../Microsoft.AnalysisServices.json | 171 - .../AnalysisServices/2017-07-14/servers.md | 77 - .../Microsoft.AnalysisServices.json | 253 - .../2017-08-01-beta/servers.md | 109 - .../2016-10-10/Microsoft.ApiManagement.json | 3073 ------- .../ApiManagement/2016-10-10/service.md | 128 - .../ApiManagement/2016-10-10/service/apis.md | 72 - .../2016-10-10/service/apis/operations.md | 130 - .../service/authorizationServers.md | 76 - .../2016-10-10/service/backends.md | 60 - .../2016-10-10/service/certificates.md | 29 - .../2016-10-10/service/groups.md | 31 - .../2016-10-10/service/groups/users.md | 25 - .../2016-10-10/service/identityProviders.md | 33 - .../2016-10-10/service/loggers.md | 31 - .../service/openidConnectProviders.md | 33 - .../2016-10-10/service/products.md | 39 - .../2016-10-10/service/products/apis.md | 25 - .../2016-10-10/service/products/groups.md | 25 - .../2016-10-10/service/properties.md | 33 - .../2016-10-10/service/subscriptions.md | 35 - .../ApiManagement/2016-10-10/service/users.md | 37 - .../2017-03-01/Microsoft.ApiManagement.json | 4383 ---------- .../ApiManagement/2017-03-01/service.md | 149 - .../ApiManagement/2017-03-01/service/apis.md | 108 - .../2017-03-01/service/apis/operations.md | 189 - .../service/apis/operations/policies.md | 36 - .../2017-03-01/service/apis/policies.md | 36 - .../2017-03-01/service/apis/schemas.md | 47 - .../service/authorizationServers.md | 87 - .../2017-03-01/service/backends.md | 147 - .../2017-03-01/service/certificates.md | 38 - .../2017-03-01/service/groups.md | 44 - .../2017-03-01/service/groups/users.md | 25 - .../2017-03-01/service/identityProviders.md | 52 - .../2017-03-01/service/loggers.md | 42 - .../2017-03-01/service/notifications.md | 27 - .../service/notifications/recipientEmails.md | 25 - .../service/notifications/recipientUsers.md | 25 - .../service/openidConnectProviders.md | 44 - .../2017-03-01/service/policies.md | 36 - .../2017-03-01/service/products.md | 50 - .../2017-03-01/service/products/apis.md | 25 - .../2017-03-01/service/products/groups.md | 25 - .../2017-03-01/service/products/policies.md | 36 - .../2017-03-01/service/properties.md | 44 - .../2017-03-01/service/subscriptions.md | 46 - .../2017-03-01/service/templates.md | 59 - .../ApiManagement/2017-03-01/service/users.md | 48 - .../2015-10-31/Microsoft.Automation.json | 2476 ------ .../2015-10-31/automationAccounts.md | 55 - .../automationAccounts/certificates.md | 42 - .../automationAccounts/compilationjobs.md | 53 - .../automationAccounts/configurations.md | 74 - .../automationAccounts/connectionTypes.md | 38 - .../automationAccounts/connections.md | 49 - .../automationAccounts/credentials.md | 40 - .../automationAccounts/jobSchedules.md | 60 - .../2015-10-31/automationAccounts/jobs.md | 53 - .../2015-10-31/automationAccounts/modules.md | 64 - .../automationAccounts/nodeConfigurations.md | 66 - .../2015-10-31/automationAccounts/runbooks.md | 104 - .../automationAccounts/schedules.md | 78 - .../automationAccounts/variables.md | 40 - .../2015-10-31/automationAccounts/webhooks.md | 55 - .../Microsoft.Automation.json | 455 - .../softwareUpdateConfigurations.md | 163 - .../Batch/2015-12-01/Microsoft.Batch.json | 252 - .../Batch/2015-12-01/batchAccounts.md | 51 - .../2015-12-01/batchAccounts/applications.md | 31 - .../batchAccounts/applications/versions.md | 25 - .../Batch/2017-01-01/Microsoft.Batch.json | 296 - .../Batch/2017-01-01/batchAccounts.md | 66 - .../2017-01-01/batchAccounts/applications.md | 31 - .../batchAccounts/applications/versions.md | 25 - .../Batch/2017-05-01/Microsoft.Batch.json | 296 - .../Batch/2017-05-01/batchAccounts.md | 66 - .../2017-05-01/batchAccounts/applications.md | 31 - .../batchAccounts/applications/versions.md | 25 - .../Batch/2017-09-01/Microsoft.Batch.json | 1507 ---- .../Batch/2017-09-01/batchAccounts.md | 66 - .../2017-09-01/batchAccounts/applications.md | 31 - .../batchAccounts/applications/versions.md | 25 - .../2017-09-01/batchAccounts/certificates.md | 44 - .../Batch/2017-09-01/batchAccounts/pools.md | 405 - .../Compute/2015-06-15/Microsoft.Compute.json | 2025 ----- .../Compute/2015-06-15/availabilitySets.md | 55 - .../2015-06-15/virtualMachineScaleSets.md | 409 - .../Compute/2015-06-15/virtualMachines.md | 406 - .../2015-06-15/virtualMachines/extensions.md | 98 - .../Microsoft.ContainerService.json | 393 - .../2015-11-01-preview/containerServices.md | 147 - .../Compute/2016-03-30/Microsoft.Compute.json | 2105 ----- .../Microsoft.ContainerService.json | 406 - .../Compute/2016-03-30/availabilitySets.md | 55 - .../Compute/2016-03-30/containerServices.md | 147 - .../2016-03-30/virtualMachineScaleSets.md | 424 - .../Compute/2016-03-30/virtualMachines.md | 417 - .../2016-03-30/virtualMachines/extensions.md | 98 - .../2016-04-30-preview/Microsoft.Compute.json | 2963 ------- .../2016-04-30-preview/availabilitySets.md | 72 - .../Compute/2016-04-30-preview/disks.md | 122 - .../Compute/2016-04-30-preview/images.md | 112 - .../Compute/2016-04-30-preview/snapshots.md | 122 - .../virtualMachineScaleSets.md | 479 - .../2016-04-30-preview/virtualMachines.md | 437 - .../virtualMachines/extensions.md | 98 - .../Microsoft.ContainerService.json | 487 -- .../Compute/2017-01-31/containerServices.md | 171 - .../Compute/2017-03-30/Microsoft.Compute.json | 3420 -------- .../Compute/2017-03-30/availabilitySets.md | 70 - .../Expected/Compute/2017-03-30/disks.md | 135 - .../Expected/Compute/2017-03-30/images.md | 116 - .../Expected/Compute/2017-03-30/snapshots.md | 131 - .../2017-03-30/virtualMachineScaleSets.md | 590 -- .../virtualMachineScaleSets/extensions.md | 48 - .../Compute/2017-03-30/virtualMachines.md | 441 - .../2017-03-30/virtualMachines/extensions.md | 98 - .../Compute/2017-12-01/Microsoft.Compute.json | 3294 ------- .../Compute/2017-12-01/availabilitySets.md | 70 - .../Expected/Compute/2017-12-01/images.md | 116 - .../2017-12-01/virtualMachineScaleSets.md | 598 -- .../virtualMachineScaleSets/extensions.md | 48 - .../virtualmachines.md | 424 - .../Compute/2017-12-01/virtualMachines.md | 445 - .../2017-12-01/virtualMachines/extensions.md | 98 - .../Microsoft.ContainerRegistry.json | 119 - .../2016-06-27-preview/registries.md | 53 - .../Microsoft.ContainerRegistry.json | 152 - .../2017-03-01/registries.md | 64 - .../Microsoft.ContainerRegistry.json | 509 -- .../2017-06-01-preview/registries.md | 64 - .../registries/replications.md | 31 - .../2017-06-01-preview/registries/webhooks.md | 50 - .../Microsoft.ContainerRegistry.json | 509 -- .../2017-10-01/registries.md | 64 - .../2017-10-01/registries/replications.md | 31 - .../2017-10-01/registries/webhooks.md | 50 - .../Microsoft.CustomerInsights.json | 3085 ------- .../CustomerInsights/2017-01-01/hubs.md | 57 - .../2017-01-01/hubs/authorizationPolicies.md | 42 - .../2017-01-01/hubs/connectors.md | 48 - .../2017-01-01/hubs/connectors/mappings.md | 138 - .../2017-01-01/hubs/interactions.md | 160 - .../CustomerInsights/2017-01-01/hubs/kpi.md | 103 - .../CustomerInsights/2017-01-01/hubs/links.md | 80 - .../2017-01-01/hubs/profiles.md | 135 - .../2017-01-01/hubs/relationshipLinks.md | 81 - .../2017-01-01/hubs/relationships.md | 126 - .../2017-01-01/hubs/roleAssignments.md | 182 - .../CustomerInsights/2017-01-01/hubs/views.md | 40 - .../Microsoft.CustomerInsights.json | 3407 -------- .../CustomerInsights/2017-04-26/hubs.md | 57 - .../2017-04-26/hubs/authorizationPolicies.md | 42 - .../2017-04-26/hubs/connectors.md | 48 - .../2017-04-26/hubs/connectors/mappings.md | 138 - .../2017-04-26/hubs/interactions.md | 160 - .../CustomerInsights/2017-04-26/hubs/kpi.md | 103 - .../CustomerInsights/2017-04-26/hubs/links.md | 82 - .../2017-04-26/hubs/predictions.md | 96 - .../2017-04-26/hubs/profiles.md | 135 - .../2017-04-26/hubs/relationshipLinks.md | 81 - .../2017-04-26/hubs/relationships.md | 126 - .../2017-04-26/hubs/roleAssignments.md | 182 - .../CustomerInsights/2017-04-26/hubs/views.md | 40 - .../Microsoft.DevTestLab.json | 1820 ---- .../DevTestLabs/2015-05-21-preview/labs.md | 60 - .../labs/artifactsources.md | 56 - .../2015-05-21-preview/labs/customimages.md | 98 - .../2015-05-21-preview/labs/formulas.md | 185 - .../labs/policysets/policies.md | 54 - .../2015-05-21-preview/labs/schedules.md | 85 - .../labs/virtualmachines.md | 136 - .../labs/virtualnetworks.md | 82 - .../2016-05-15/Microsoft.DevTestLab.json | 4049 --------- .../Expected/DevTestLabs/2016-05-15/labs.md | 50 - .../2016-05-15/labs/artifactsources.md | 58 - .../DevTestLabs/2016-05-15/labs/costs.md | 99 - .../2016-05-15/labs/customimages.md | 96 - .../DevTestLabs/2016-05-15/labs/formulas.md | 458 - .../2016-05-15/labs/notificationchannels.md | 59 - .../2016-05-15/labs/policysets/policies.md | 54 - .../DevTestLabs/2016-05-15/labs/schedules.md | 102 - .../2016-05-15/labs/servicerunners.md | 46 - .../DevTestLabs/2016-05-15/labs/users.md | 76 - .../2016-05-15/labs/users/disks.md | 56 - .../2016-05-15/labs/users/environments.md | 70 - .../2016-05-15/labs/users/secrets.md | 44 - .../2016-05-15/labs/virtualmachines.md | 404 - .../labs/virtualmachines/schedules.md | 102 - .../2016-05-15/labs/virtualnetworks.md | 123 - .../DevTestLabs/2016-05-15/schedules.md | 102 - .../Microsoft.EventGrid.json | 73 - .../2017-06-15-preview/eventSubscriptions.md | 84 - .../EventGrid/2017-06-15-preview/topics.md | 31 - .../Microsoft.EventGrid.json | 73 - .../2017-09-15-preview/eventSubscriptions.md | 64 - .../EventGrid/2017-09-15-preview/topics.md | 31 - .../2018-01-01/Microsoft.EventGrid.json | 73 - .../2018-01-01/eventSubscriptions.md | 64 - .../Expected/EventGrid/2018-01-01/topics.md | 31 - .../EventHub/2015-08-01/namespaces.md | 67 - .../namespaces/AuthorizationRules.md | 40 - .../2015-08-01/namespaces/eventhubs.md | 44 - .../eventhubs/authorizationRules.md | 40 - .../namespaces/eventhubs/consumergroups.md | 38 - .../EventHub/2017-04-01/namespaces.md | 59 - .../namespaces/AuthorizationRules.md | 38 - .../namespaces/disasterRecoveryConfigs.md | 38 - .../2017-04-01/namespaces/eventhubs.md | 85 - .../eventhubs/authorizationRules.md | 38 - .../namespaces/eventhubs/consumergroups.md | 36 - .../2015-02-01-preview/Microsoft.Logic.json | 390 - .../Logic/2015-02-01-preview/workflows.md | 111 - .../workflows/accessKeys.md | 40 - .../2015-08-01-preview/Microsoft.Logic.json | 4092 --------- .../2015-08-01-preview/integrationAccounts.md | 46 - .../integrationAccounts/agreements.md | 1378 --- .../integrationAccounts/certificates.md | 68 - .../integrationAccounts/maps.md | 48 - .../integrationAccounts/partners.md | 77 - .../integrationAccounts/schemas.md | 50 - .../Logic/2016-06-01/Microsoft.Logic.json | 4808 ---------- .../Logic/2016-06-01/integrationAccounts.md | 44 - .../integrationAccounts/agreements.md | 1382 --- .../integrationAccounts/certificates.md | 66 - .../2016-06-01/integrationAccounts/maps.md | 57 - .../integrationAccounts/partners.md | 75 - .../2016-06-01/integrationAccounts/schemas.md | 52 - .../integrationAccounts/sessions.md | 40 - .../Expected/Logic/2016-06-01/workflows.md | 59 - .../2017-12-01/Microsoft.BotService.json | 1513 ++++ .../2018-07-12/Microsoft.BotService.json | 1695 ++++ .../2018-01-01/Microsoft.DataBox.json | 523 ++ .../2019-03-01/Microsoft.DataBoxEdge.json | 1699 ++++ .../2019-07-01/Microsoft.DataBoxEdge.json | 1711 ++++ .../2018-04-01/Microsoft.Databricks.json | 169 + .../2019-04-01/Microsoft.DevSpaces.json | 141 + .../2015-04-08/Microsoft.DocumentDB.json | 2561 ++++++ .../2019-08-01/Microsoft.DocumentDB.json | 4293 +++++++++ .../Microsoft.EnterpriseKnowledgeGraph.json | 143 + .../2014-09-01/Microsoft.EventHub.json | 664 ++ .../2015-08-01/Microsoft.EventHub.json | 70 +- .../2017-04-01/Microsoft.EventHub.json | 309 +- .../Microsoft.EventHub.json | 631 ++ .../Microsoft.IoTSpaces.json | 148 + .../2018-10-15/Microsoft.LabServices.json | 962 ++ .../Microsoft.MachineLearningCompute.json | 533 ++ .../Microsoft.MachineLearningCompute.json | 566 ++ .../2015-08-01-preview/Microsoft.Portal.json | 268 + .../2018-10-01-preview/Microsoft.Portal.json | 268 + .../2019-01-01-preview/Microsoft.Portal.json | 268 + .../2016-07-01/Microsoft.Relay.json | 62 +- .../2017-04-01/Microsoft.Relay.json | 42 +- .../2015-08-01/Microsoft.ServiceBus.json | 178 +- .../2017-04-01/Microsoft.ServiceBus.json | 526 +- .../Microsoft.ServiceBus.json | 567 ++ .../2016-09-01/Microsoft.ServiceFabric.json | 101 +- .../Microsoft.ServiceFabric.json | 765 +- .../2018-02-01/Microsoft.ServiceFabric.json | 990 +++ .../Microsoft.ServiceFabric.json | 2146 +++++ .../2019-03-01/Microsoft.ServiceFabric.json | 2146 +++++ .../Microsoft.ServiceFabricMesh.json | 992 +++ .../Microsoft.ServiceFabricMesh.json | 1757 ++++ .../Microsoft.SqlVirtualMachine.json | 962 ++ .../Microsoft.StorageSync.json | 699 ++ .../2018-04-02/Microsoft.StorageSync.json | 637 ++ .../2018-07-01/Microsoft.StorageSync.json | 504 ++ .../2018-10-01/Microsoft.StorageSync.json | 520 ++ .../2019-02-01/Microsoft.StorageSync.json | 520 ++ .../2019-03-01/Microsoft.StorageSync.json | 521 ++ .../Microsoft.WindowsIoT.json | 97 + .../2019-06-01/Microsoft.WindowsIoT.json | 59 + .../Monitor/2015-04-01/autoscalesettings.md | 219 - .../2015-04-01/microsoft.insights.json | 634 -- .../Expected/Monitor/2016-03-01/alertrules.md | 68 - .../Monitor/2016-03-01/logprofiles.md | 63 - .../2016-03-01/microsoft.insights.json | 510 -- .../Monitor/2017-04-01/actionGroups.md | 148 - .../Monitor/2017-04-01/activityLogAlerts.md | 94 - .../2017-04-01/microsoft.insights.json | 544 -- .../2017-05-01-preview/diagnosticSettings.md | 92 - .../microsoft.insights.json | 206 - .../Network/2016-03-30/Microsoft.Network.json | 5376 ------------ .../Network/2016-03-30/applicationGateways.md | 1127 --- .../Network/2016-03-30/connections.md | 383 - .../2016-03-30/expressRouteCircuits.md | 202 - .../expressRouteCircuits/authorizations.md | 44 - .../expressRouteCircuits/peerings.md | 96 - .../Network/2016-03-30/loadBalancers.md | 1814 ---- .../2016-03-30/localNetworkGateways.md | 76 - .../Network/2016-03-30/networkInterfaces.md | 815 -- .../2016-03-30/networkSecurityGroups.md | 717 -- .../networkSecurityGroups/securityRules.md | 58 - .../Network/2016-03-30/publicIPAddresses.md | 569 -- .../Network/2016-03-30/routeTables.md | 595 -- .../Network/2016-03-30/routeTables/routes.md | 46 - .../2016-03-30/virtualNetworkGateways.md | 215 - .../Network/2016-03-30/virtualNetworks.md | 636 -- .../2016-03-30/virtualNetworks/subnets.md | 609 -- .../Network/2016-06-01/Microsoft.Network.json | 5462 ------------ .../Network/2016-06-01/applicationGateways.md | 921 -- .../Network/2016-06-01/connections.md | 383 - .../2016-06-01/expressRouteCircuits.md | 208 - .../expressRouteCircuits/authorizations.md | 44 - .../expressRouteCircuits/peerings.md | 100 - .../Network/2016-06-01/loadBalancers.md | 592 -- .../2016-06-01/localNetworkGateways.md | 76 - .../Network/2016-06-01/networkInterfaces.md | 555 -- .../2016-06-01/networkSecurityGroups.md | 114 - .../networkSecurityGroups/securityRules.md | 58 - .../Network/2016-06-01/publicIPAddresses.md | 69 - .../Network/2016-06-01/routeTables.md | 80 - .../Network/2016-06-01/routeTables/routes.md | 46 - .../2016-06-01/virtualNetworkGateways.md | 215 - .../Network/2016-06-01/virtualNetworks.md | 339 - .../2016-06-01/virtualNetworks/subnets.md | 228 - .../virtualNetworks/virtualNetworkPeerings.md | 61 - .../Network/2016-09-01/Microsoft.Network.json | 5773 ------------ .../Network/2016-09-01/applicationGateways.md | 934 -- .../Network/2016-09-01/connections.md | 361 - .../2016-09-01/expressRouteCircuits.md | 208 - .../expressRouteCircuits/authorizations.md | 44 - .../expressRouteCircuits/peerings.md | 100 - .../Network/2016-09-01/loadBalancers.md | 592 -- .../2016-09-01/localNetworkGateways.md | 74 - .../Network/2016-09-01/networkInterfaces.md | 557 -- .../2016-09-01/networkSecurityGroups.md | 114 - .../networkSecurityGroups/securityRules.md | 58 - .../Network/2016-09-01/networkWatchers.md | 37 - .../networkWatchers/packetCaptures.md | 78 - .../Network/2016-09-01/publicIPAddresses.md | 69 - .../Network/2016-09-01/routeTables.md | 80 - .../Network/2016-09-01/routeTables/routes.md | 46 - .../2016-09-01/virtualNetworkGateways.md | 207 - .../Network/2016-09-01/virtualNetworks.md | 339 - .../2016-09-01/virtualNetworks/subnets.md | 228 - .../virtualNetworks/virtualNetworkPeerings.md | 61 - .../Network/2016-12-01/Microsoft.Network.json | 6127 ------------- .../Network/2016-12-01/applicationGateways.md | 947 -- .../Network/2016-12-01/connections.md | 361 - .../2016-12-01/expressRouteCircuits.md | 260 - .../expressRouteCircuits/authorizations.md | 42 - .../expressRouteCircuits/peerings.md | 156 - .../Network/2016-12-01/loadBalancers.md | 592 -- .../2016-12-01/localNetworkGateways.md | 74 - .../Network/2016-12-01/networkInterfaces.md | 557 -- .../2016-12-01/networkSecurityGroups.md | 114 - .../networkSecurityGroups/securityRules.md | 58 - .../Network/2016-12-01/networkWatchers.md | 37 - .../networkWatchers/packetCaptures.md | 78 - .../Network/2016-12-01/publicIPAddresses.md | 69 - .../Network/2016-12-01/routeFilters.md | 76 - .../routeFilters/routeFilterRules.md | 48 - .../Network/2016-12-01/routeTables.md | 80 - .../Network/2016-12-01/routeTables/routes.md | 46 - .../2016-12-01/virtualNetworkGateways.md | 207 - .../Network/2016-12-01/virtualNetworks.md | 339 - .../2016-12-01/virtualNetworks/subnets.md | 228 - .../virtualNetworks/virtualNetworkPeerings.md | 61 - .../Network/2017-03-01/Microsoft.Network.json | 6428 -------------- .../Network/2017-03-01/applicationGateways.md | 968 --- .../Network/2017-03-01/connections.md | 390 - .../2017-03-01/expressRouteCircuits.md | 306 - .../expressRouteCircuits/authorizations.md | 42 - .../expressRouteCircuits/peerings.md | 202 - .../Network/2017-03-01/loadBalancers.md | 592 -- .../2017-03-01/localNetworkGateways.md | 74 - .../Network/2017-03-01/networkInterfaces.md | 557 -- .../2017-03-01/networkSecurityGroups.md | 114 - .../networkSecurityGroups/securityRules.md | 58 - .../Network/2017-03-01/networkWatchers.md | 37 - .../networkWatchers/packetCaptures.md | 78 - .../Network/2017-03-01/publicIPAddresses.md | 69 - .../Network/2017-03-01/routeFilters.md | 76 - .../routeFilters/routeFilterRules.md | 48 - .../Network/2017-03-01/routeTables.md | 80 - .../Network/2017-03-01/routeTables/routes.md | 46 - .../2017-03-01/virtualNetworkGateways.md | 207 - .../Network/2017-03-01/virtualNetworks.md | 339 - .../2017-03-01/virtualNetworks/subnets.md | 228 - .../virtualNetworks/virtualNetworkPeerings.md | 61 - .../Network/2017-06-01/Microsoft.Network.json | 7198 --------------- .../Network/2017-06-01/applicationGateways.md | 1152 --- .../Network/2017-06-01/connections.md | 403 - .../2017-06-01/expressRouteCircuits.md | 326 - .../expressRouteCircuits/authorizations.md | 42 - .../expressRouteCircuits/peerings.md | 239 - .../Network/2017-06-01/loadBalancers.md | 649 -- .../loadBalancers/inboundNatRules.md | 61 - .../2017-06-01/localNetworkGateways.md | 74 - .../Network/2017-06-01/networkInterfaces.md | 634 -- .../2017-06-01/networkSecurityGroups.md | 142 - .../networkSecurityGroups/securityRules.md | 74 - .../Network/2017-06-01/networkWatchers.md | 37 - .../networkWatchers/packetCaptures.md | 78 - .../Network/2017-06-01/publicIPAddresses.md | 73 - .../Network/2017-06-01/routeFilters.md | 222 - .../routeFilters/routeFilterRules.md | 48 - .../Network/2017-06-01/routeTables.md | 80 - .../Network/2017-06-01/routeTables/routes.md | 46 - .../2017-06-01/virtualNetworkGateways.md | 215 - .../Network/2017-06-01/virtualNetworks.md | 386 - .../2017-06-01/virtualNetworks/subnets.md | 275 - .../virtualNetworks/virtualNetworkPeerings.md | 61 - .../Network/2017-08-01/Microsoft.Network.json | 7283 ---------------- .../Network/2017-08-01/applicationGateways.md | 1163 --- .../Network/2017-08-01/connections.md | 403 - .../2017-08-01/expressRouteCircuits.md | 326 - .../expressRouteCircuits/authorizations.md | 42 - .../expressRouteCircuits/peerings.md | 239 - .../Network/2017-08-01/loadBalancers.md | 673 -- .../loadBalancers/inboundNatRules.md | 61 - .../2017-08-01/localNetworkGateways.md | 74 - .../Network/2017-08-01/networkInterfaces.md | 645 -- .../2017-08-01/networkSecurityGroups.md | 142 - .../networkSecurityGroups/securityRules.md | 74 - .../Network/2017-08-01/networkWatchers.md | 37 - .../networkWatchers/packetCaptures.md | 78 - .../Network/2017-08-01/publicIPAddresses.md | 84 - .../Network/2017-08-01/routeFilters.md | 222 - .../routeFilters/routeFilterRules.md | 48 - .../Network/2017-08-01/routeTables.md | 80 - .../Network/2017-08-01/routeTables/routes.md | 46 - .../2017-08-01/virtualNetworkGateways.md | 215 - .../Network/2017-08-01/virtualNetworks.md | 386 - .../2017-08-01/virtualNetworks/subnets.md | 275 - .../virtualNetworks/virtualNetworkPeerings.md | 61 - .../Network/2017-09-01/Microsoft.Network.json | 7464 ---------------- .../Network/2017-09-01/applicationGateways.md | 1216 --- .../2017-09-01/applicationSecurityGroups.md | 33 - .../Network/2017-09-01/connections.md | 403 - .../2017-09-01/expressRouteCircuits.md | 326 - .../expressRouteCircuits/authorizations.md | 42 - .../expressRouteCircuits/peerings.md | 239 - .../Network/2017-09-01/loadBalancers.md | 717 -- .../loadBalancers/inboundNatRules.md | 61 - .../2017-09-01/localNetworkGateways.md | 74 - .../Network/2017-09-01/networkInterfaces.md | 730 -- .../2017-09-01/networkSecurityGroups.md | 186 - .../networkSecurityGroups/securityRules.md | 102 - .../Network/2017-09-01/networkWatchers.md | 37 - .../networkWatchers/packetCaptures.md | 78 - .../Network/2017-09-01/publicIPAddresses.md | 84 - .../Network/2017-09-01/routeFilters.md | 222 - .../routeFilters/routeFilterRules.md | 48 - .../Network/2017-09-01/routeTables.md | 80 - .../Network/2017-09-01/routeTables/routes.md | 46 - .../2017-09-01/virtualNetworkGateways.md | 215 - .../Network/2017-09-01/virtualNetworks.md | 440 - .../2017-09-01/virtualNetworks/subnets.md | 319 - .../virtualNetworks/virtualNetworkPeerings.md | 74 - .../Network/2017-10-01/Microsoft.Network.json | 7706 ----------------- .../Network/2017-10-01/applicationGateways.md | 1220 --- .../2017-10-01/applicationSecurityGroups.md | 33 - .../Network/2017-10-01/connections.md | 403 - .../2017-10-01/expressRouteCircuits.md | 326 - .../expressRouteCircuits/authorizations.md | 42 - .../expressRouteCircuits/peerings.md | 239 - .../Network/2017-10-01/loadBalancers.md | 719 -- .../loadBalancers/inboundNatRules.md | 61 - .../2017-10-01/localNetworkGateways.md | 74 - .../Network/2017-10-01/networkInterfaces.md | 732 -- .../2017-10-01/networkSecurityGroups.md | 186 - .../networkSecurityGroups/securityRules.md | 102 - .../Network/2017-10-01/networkWatchers.md | 37 - .../networkWatchers/connectionMonitors.md | 70 - .../networkWatchers/packetCaptures.md | 78 - .../Network/2017-10-01/publicIPAddresses.md | 84 - .../Network/2017-10-01/routeFilters.md | 222 - .../routeFilters/routeFilterRules.md | 48 - .../Network/2017-10-01/routeTables.md | 82 - .../Network/2017-10-01/routeTables/routes.md | 46 - .../2017-10-01/virtualNetworkGateways.md | 215 - .../Network/2017-10-01/virtualNetworks.md | 442 - .../2017-10-01/virtualNetworks/subnets.md | 321 - .../virtualNetworks/virtualNetworkPeerings.md | 74 - .../Microsoft.RecoveryServices.json | 249 - .../RecoveryServices/2016-06-01/vaults.md | 55 - .../2016-06-01/vaults/certificates.md | 40 - .../Expected/Relay/2016-07-01/namespaces.md | 46 - .../namespaces/AuthorizationRules.md | 38 - .../namespaces/HybridConnections.md | 40 - .../HybridConnections/authorizationRules.md | 38 - .../Relay/2016-07-01/namespaces/WcfRelays.md | 44 - .../WcfRelays/authorizationRules.md | 38 - .../Expected/Relay/2017-04-01/namespaces.md | 46 - .../namespaces/authorizationRules.md | 38 - .../namespaces/hybridConnections.md | 40 - .../hybridConnections/authorizationRules.md | 38 - .../Relay/2017-04-01/namespaces/wcfRelays.md | 44 - .../wcfRelays/authorizationRules.md | 38 - .../ServiceBus/2015-08-01/namespaces.md | 61 - .../namespaces/AuthorizationRules.md | 40 - .../2015-08-01/namespaces/queues.md | 70 - .../namespaces/queues/authorizationRules.md | 40 - .../2015-08-01/namespaces/topics.md | 68 - .../namespaces/topics/authorizationRules.md | 40 - .../namespaces/topics/subscriptions.md | 58 - .../ServiceBus/2017-04-01/namespaces.md | 48 - .../namespaces/AuthorizationRules.md | 38 - .../namespaces/disasterRecoveryConfigs.md | 38 - .../2017-04-01/namespaces/queues.md | 64 - .../namespaces/queues/authorizationRules.md | 38 - .../2017-04-01/namespaces/topics.md | 56 - .../namespaces/topics/authorizationRules.md | 38 - .../namespaces/topics/subscriptions.md | 58 - .../namespaces/topics/subscriptions/rules.md | 91 - .../ServiceFabric/2016-09-01/clusters.md | 263 - .../2017-07-01-preview/clusters.md | 286 - .../clusters/applicationTypes.md | 31 - .../clusters/applicationTypes/versions.md | 38 - .../clusters/applications.md | 161 - .../clusters/applications/services.md | 84 - .../2015-05-01-preview/Microsoft.Storage.json | 90 - .../2015-05-01-preview/storageAccounts.md | 40 - .../Storage/2015-06-15/Microsoft.Storage.json | 94 - .../Storage/2015-06-15/storageAccounts.md | 40 - .../Storage/2016-01-01/Microsoft.Storage.json | 256 - .../Storage/2016-01-01/storageAccounts.md | 97 - .../Storage/2016-05-01/Microsoft.Storage.json | 257 - .../Storage/2016-05-01/storageAccounts.md | 97 - .../Storage/2016-12-01/Microsoft.Storage.json | 280 - .../Storage/2016-12-01/storageAccounts.md | 103 - .../Storage/2017-06-01/Microsoft.Storage.json | 532 -- .../Storage/2017-06-01/storageAccounts.md | 187 - .../Storage/2017-10-01/Microsoft.Storage.json | 533 -- .../Storage/2017-10-01/storageAccounts.md | 187 - .../Microsoft.TimeSeriesInsights.json | 669 -- .../2017-11-15/environments.md | 57 - .../2017-11-15/environments/accessPolicies.md | 42 - .../2017-11-15/environments/eventSources.md | 29 - .../environments/referenceDataSets.md | 53 - .../Microsoft.DomainRegistration.json | 425 - .../Expected/Web/2015-04-01/domains.md | 174 - .../domains/domainOwnershipIdentifiers.md | 38 - .../Microsoft.CertificateRegistration.json | 305 - .../Web/2015-08-01/certificateOrders.md | 56 - .../certificateOrders/certificates.md | 44 - .../Web/2016-03-01/Microsoft.Web.json | 125 - .../Expected/Web/2016-03-01/certificates.md | 56 - .../Expected/Web/2016-03-01/sourcecontrols.md | 46 - .../Web/2016-08-01/Microsoft.Web.json | 3950 --------- .../Resource/Expected/Web/2016-08-01/sites.md | 546 -- .../Web/2016-08-01/sites/deployments.md | 56 - .../sites/domainOwnershipIdentifiers.md | 38 - .../Web/2016-08-01/sites/functions.md | 52 - .../Web/2016-08-01/sites/hostNameBindings.md | 52 - .../hybridConnectionNamespaces/relays.md | 52 - .../Web/2016-08-01/sites/hybridconnection.md | 50 - .../Web/2016-08-01/sites/premieraddons.md | 56 - .../2016-08-01/sites/publicCertificates.md | 42 - .../Web/2016-08-01/sites/siteextensions.md | 25 - .../Expected/Web/2016-08-01/sites/slots.md | 546 -- .../Web/2016-08-01/sites/slots/deployments.md | 56 - .../sites/slots/domainOwnershipIdentifiers.md | 38 - .../Web/2016-08-01/sites/slots/functions.md | 52 - .../sites/slots/hostNameBindings.md | 52 - .../hybridConnectionNamespaces/relays.md | 52 - .../sites/slots/hybridconnection.md | 50 - .../2016-08-01/sites/slots/premieraddons.md | 56 - .../sites/slots/publicCertificates.md | 42 - .../2016-08-01/sites/slots/siteextensions.md | 25 - .../sites/slots/virtualNetworkConnections.md | 46 - .../virtualNetworkConnections/gateways.md | 40 - .../sites/virtualNetworkConnections.md | 46 - .../virtualNetworkConnections/gateways.md | 40 - .../Web/2016-09-01/Microsoft.Web.json | 928 -- .../Web/2016-09-01/hostingEnvironments.md | 140 - .../hostingEnvironments/workerPools.md | 101 - .../Expected/Web/2016-09-01/serverfarms.md | 126 - .../virtualNetworkConnections/gateways.md | 40 - .../virtualNetworkConnections/routes.md | 44 - 578 files changed, 33216 insertions(+), 198191 deletions(-) delete mode 100644 test/Resource/Expected/AnalysisServices/2016-05-16/Microsoft.AnalysisServices.json delete mode 100644 test/Resource/Expected/AnalysisServices/2016-05-16/servers.md delete mode 100644 test/Resource/Expected/AnalysisServices/2017-07-14/Microsoft.AnalysisServices.json delete mode 100644 test/Resource/Expected/AnalysisServices/2017-07-14/servers.md delete mode 100644 test/Resource/Expected/AnalysisServices/2017-08-01-beta/Microsoft.AnalysisServices.json delete mode 100644 test/Resource/Expected/AnalysisServices/2017-08-01-beta/servers.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/Microsoft.ApiManagement.json delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/apis.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/apis/operations.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/authorizationServers.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/backends.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/certificates.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/groups.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/groups/users.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/identityProviders.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/loggers.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/openidConnectProviders.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/products.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/products/apis.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/products/groups.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/properties.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/subscriptions.md delete mode 100644 test/Resource/Expected/ApiManagement/2016-10-10/service/users.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/Microsoft.ApiManagement.json delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/apis.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/apis/operations.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/apis/operations/policies.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/apis/policies.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/apis/schemas.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/authorizationServers.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/backends.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/certificates.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/groups.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/groups/users.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/identityProviders.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/loggers.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/notifications.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/notifications/recipientEmails.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/notifications/recipientUsers.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/openidConnectProviders.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/policies.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/products.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/products/apis.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/products/groups.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/products/policies.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/properties.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/subscriptions.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/templates.md delete mode 100644 test/Resource/Expected/ApiManagement/2017-03-01/service/users.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/Microsoft.Automation.json delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/certificates.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/compilationjobs.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/configurations.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/connectionTypes.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/connections.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/credentials.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/jobSchedules.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/jobs.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/modules.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/nodeConfigurations.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/runbooks.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/schedules.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/variables.md delete mode 100644 test/Resource/Expected/Automation/2015-10-31/automationAccounts/webhooks.md delete mode 100644 test/Resource/Expected/Automation/2017-05-15-preview/Microsoft.Automation.json delete mode 100644 test/Resource/Expected/Automation/2017-05-15-preview/automationAccounts/softwareUpdateConfigurations.md delete mode 100644 test/Resource/Expected/Batch/2015-12-01/Microsoft.Batch.json delete mode 100644 test/Resource/Expected/Batch/2015-12-01/batchAccounts.md delete mode 100644 test/Resource/Expected/Batch/2015-12-01/batchAccounts/applications.md delete mode 100644 test/Resource/Expected/Batch/2015-12-01/batchAccounts/applications/versions.md delete mode 100644 test/Resource/Expected/Batch/2017-01-01/Microsoft.Batch.json delete mode 100644 test/Resource/Expected/Batch/2017-01-01/batchAccounts.md delete mode 100644 test/Resource/Expected/Batch/2017-01-01/batchAccounts/applications.md delete mode 100644 test/Resource/Expected/Batch/2017-01-01/batchAccounts/applications/versions.md delete mode 100644 test/Resource/Expected/Batch/2017-05-01/Microsoft.Batch.json delete mode 100644 test/Resource/Expected/Batch/2017-05-01/batchAccounts.md delete mode 100644 test/Resource/Expected/Batch/2017-05-01/batchAccounts/applications.md delete mode 100644 test/Resource/Expected/Batch/2017-05-01/batchAccounts/applications/versions.md delete mode 100644 test/Resource/Expected/Batch/2017-09-01/Microsoft.Batch.json delete mode 100644 test/Resource/Expected/Batch/2017-09-01/batchAccounts.md delete mode 100644 test/Resource/Expected/Batch/2017-09-01/batchAccounts/applications.md delete mode 100644 test/Resource/Expected/Batch/2017-09-01/batchAccounts/applications/versions.md delete mode 100644 test/Resource/Expected/Batch/2017-09-01/batchAccounts/certificates.md delete mode 100644 test/Resource/Expected/Batch/2017-09-01/batchAccounts/pools.md delete mode 100644 test/Resource/Expected/Compute/2015-06-15/Microsoft.Compute.json delete mode 100644 test/Resource/Expected/Compute/2015-06-15/availabilitySets.md delete mode 100644 test/Resource/Expected/Compute/2015-06-15/virtualMachineScaleSets.md delete mode 100644 test/Resource/Expected/Compute/2015-06-15/virtualMachines.md delete mode 100644 test/Resource/Expected/Compute/2015-06-15/virtualMachines/extensions.md delete mode 100644 test/Resource/Expected/Compute/2015-11-01-preview/Microsoft.ContainerService.json delete mode 100644 test/Resource/Expected/Compute/2015-11-01-preview/containerServices.md delete mode 100644 test/Resource/Expected/Compute/2016-03-30/Microsoft.Compute.json delete mode 100644 test/Resource/Expected/Compute/2016-03-30/Microsoft.ContainerService.json delete mode 100644 test/Resource/Expected/Compute/2016-03-30/availabilitySets.md delete mode 100644 test/Resource/Expected/Compute/2016-03-30/containerServices.md delete mode 100644 test/Resource/Expected/Compute/2016-03-30/virtualMachineScaleSets.md delete mode 100644 test/Resource/Expected/Compute/2016-03-30/virtualMachines.md delete mode 100644 test/Resource/Expected/Compute/2016-03-30/virtualMachines/extensions.md delete mode 100644 test/Resource/Expected/Compute/2016-04-30-preview/Microsoft.Compute.json delete mode 100644 test/Resource/Expected/Compute/2016-04-30-preview/availabilitySets.md delete mode 100644 test/Resource/Expected/Compute/2016-04-30-preview/disks.md delete mode 100644 test/Resource/Expected/Compute/2016-04-30-preview/images.md delete mode 100644 test/Resource/Expected/Compute/2016-04-30-preview/snapshots.md delete mode 100644 test/Resource/Expected/Compute/2016-04-30-preview/virtualMachineScaleSets.md delete mode 100644 test/Resource/Expected/Compute/2016-04-30-preview/virtualMachines.md delete mode 100644 test/Resource/Expected/Compute/2016-04-30-preview/virtualMachines/extensions.md delete mode 100644 test/Resource/Expected/Compute/2017-01-31/Microsoft.ContainerService.json delete mode 100644 test/Resource/Expected/Compute/2017-01-31/containerServices.md delete mode 100644 test/Resource/Expected/Compute/2017-03-30/Microsoft.Compute.json delete mode 100644 test/Resource/Expected/Compute/2017-03-30/availabilitySets.md delete mode 100644 test/Resource/Expected/Compute/2017-03-30/disks.md delete mode 100644 test/Resource/Expected/Compute/2017-03-30/images.md delete mode 100644 test/Resource/Expected/Compute/2017-03-30/snapshots.md delete mode 100644 test/Resource/Expected/Compute/2017-03-30/virtualMachineScaleSets.md delete mode 100644 test/Resource/Expected/Compute/2017-03-30/virtualMachineScaleSets/extensions.md delete mode 100644 test/Resource/Expected/Compute/2017-03-30/virtualMachines.md delete mode 100644 test/Resource/Expected/Compute/2017-03-30/virtualMachines/extensions.md delete mode 100644 test/Resource/Expected/Compute/2017-12-01/Microsoft.Compute.json delete mode 100644 test/Resource/Expected/Compute/2017-12-01/availabilitySets.md delete mode 100644 test/Resource/Expected/Compute/2017-12-01/images.md delete mode 100644 test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets.md delete mode 100644 test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets/extensions.md delete mode 100644 test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets/virtualmachines.md delete mode 100644 test/Resource/Expected/Compute/2017-12-01/virtualMachines.md delete mode 100644 test/Resource/Expected/Compute/2017-12-01/virtualMachines/extensions.md delete mode 100644 test/Resource/Expected/ContainerRegistry/2016-06-27-preview/Microsoft.ContainerRegistry.json delete mode 100644 test/Resource/Expected/ContainerRegistry/2016-06-27-preview/registries.md delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-03-01/Microsoft.ContainerRegistry.json delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-03-01/registries.md delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-06-01-preview/Microsoft.ContainerRegistry.json delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries.md delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries/replications.md delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries/webhooks.md delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-10-01/Microsoft.ContainerRegistry.json delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-10-01/registries.md delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-10-01/registries/replications.md delete mode 100644 test/Resource/Expected/ContainerRegistry/2017-10-01/registries/webhooks.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/Microsoft.CustomerInsights.json delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/authorizationPolicies.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/connectors.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/connectors/mappings.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/interactions.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/kpi.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/links.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/profiles.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/relationshipLinks.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/relationships.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/roleAssignments.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-01-01/hubs/views.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/Microsoft.CustomerInsights.json delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/authorizationPolicies.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/connectors.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/connectors/mappings.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/interactions.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/kpi.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/links.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/predictions.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/profiles.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/relationshipLinks.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/relationships.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/roleAssignments.md delete mode 100644 test/Resource/Expected/CustomerInsights/2017-04-26/hubs/views.md delete mode 100644 test/Resource/Expected/DevTestLabs/2015-05-21-preview/Microsoft.DevTestLab.json delete mode 100644 test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs.md delete mode 100644 test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/artifactsources.md delete mode 100644 test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/customimages.md delete mode 100644 test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/formulas.md delete mode 100644 test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/policysets/policies.md delete mode 100644 test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/schedules.md delete mode 100644 test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/virtualmachines.md delete mode 100644 test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/virtualnetworks.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/Microsoft.DevTestLab.json delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/artifactsources.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/costs.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/customimages.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/formulas.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/notificationchannels.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/policysets/policies.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/schedules.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/servicerunners.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/users.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/disks.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/environments.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/secrets.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualmachines.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualmachines/schedules.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualnetworks.md delete mode 100644 test/Resource/Expected/DevTestLabs/2016-05-15/schedules.md delete mode 100644 test/Resource/Expected/EventGrid/2017-06-15-preview/Microsoft.EventGrid.json delete mode 100644 test/Resource/Expected/EventGrid/2017-06-15-preview/eventSubscriptions.md delete mode 100644 test/Resource/Expected/EventGrid/2017-06-15-preview/topics.md delete mode 100644 test/Resource/Expected/EventGrid/2017-09-15-preview/Microsoft.EventGrid.json delete mode 100644 test/Resource/Expected/EventGrid/2017-09-15-preview/eventSubscriptions.md delete mode 100644 test/Resource/Expected/EventGrid/2017-09-15-preview/topics.md delete mode 100644 test/Resource/Expected/EventGrid/2018-01-01/Microsoft.EventGrid.json delete mode 100644 test/Resource/Expected/EventGrid/2018-01-01/eventSubscriptions.md delete mode 100644 test/Resource/Expected/EventGrid/2018-01-01/topics.md delete mode 100644 test/Resource/Expected/EventHub/2015-08-01/namespaces.md delete mode 100644 test/Resource/Expected/EventHub/2015-08-01/namespaces/AuthorizationRules.md delete mode 100644 test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs.md delete mode 100644 test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs/authorizationRules.md delete mode 100644 test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs/consumergroups.md delete mode 100644 test/Resource/Expected/EventHub/2017-04-01/namespaces.md delete mode 100644 test/Resource/Expected/EventHub/2017-04-01/namespaces/AuthorizationRules.md delete mode 100644 test/Resource/Expected/EventHub/2017-04-01/namespaces/disasterRecoveryConfigs.md delete mode 100644 test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs.md delete mode 100644 test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs/authorizationRules.md delete mode 100644 test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs/consumergroups.md delete mode 100644 test/Resource/Expected/Logic/2015-02-01-preview/Microsoft.Logic.json delete mode 100644 test/Resource/Expected/Logic/2015-02-01-preview/workflows.md delete mode 100644 test/Resource/Expected/Logic/2015-02-01-preview/workflows/accessKeys.md delete mode 100644 test/Resource/Expected/Logic/2015-08-01-preview/Microsoft.Logic.json delete mode 100644 test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts.md delete mode 100644 test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/agreements.md delete mode 100644 test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/certificates.md delete mode 100644 test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/maps.md delete mode 100644 test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/partners.md delete mode 100644 test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/schemas.md delete mode 100644 test/Resource/Expected/Logic/2016-06-01/Microsoft.Logic.json delete mode 100644 test/Resource/Expected/Logic/2016-06-01/integrationAccounts.md delete mode 100644 test/Resource/Expected/Logic/2016-06-01/integrationAccounts/agreements.md delete mode 100644 test/Resource/Expected/Logic/2016-06-01/integrationAccounts/certificates.md delete mode 100644 test/Resource/Expected/Logic/2016-06-01/integrationAccounts/maps.md delete mode 100644 test/Resource/Expected/Logic/2016-06-01/integrationAccounts/partners.md delete mode 100644 test/Resource/Expected/Logic/2016-06-01/integrationAccounts/schemas.md delete mode 100644 test/Resource/Expected/Logic/2016-06-01/integrationAccounts/sessions.md delete mode 100644 test/Resource/Expected/Logic/2016-06-01/workflows.md create mode 100644 test/Resource/Expected/Microsoft.BotService/2017-12-01/Microsoft.BotService.json create mode 100644 test/Resource/Expected/Microsoft.BotService/2018-07-12/Microsoft.BotService.json create mode 100644 test/Resource/Expected/Microsoft.DataBox/2018-01-01/Microsoft.DataBox.json create mode 100644 test/Resource/Expected/Microsoft.DataBoxEdge/2019-03-01/Microsoft.DataBoxEdge.json create mode 100644 test/Resource/Expected/Microsoft.DataBoxEdge/2019-07-01/Microsoft.DataBoxEdge.json create mode 100644 test/Resource/Expected/Microsoft.Databricks/2018-04-01/Microsoft.Databricks.json create mode 100644 test/Resource/Expected/Microsoft.DevSpaces/2019-04-01/Microsoft.DevSpaces.json create mode 100644 test/Resource/Expected/Microsoft.DocumentDB/2015-04-08/Microsoft.DocumentDB.json create mode 100644 test/Resource/Expected/Microsoft.DocumentDB/2019-08-01/Microsoft.DocumentDB.json create mode 100644 test/Resource/Expected/Microsoft.EnterpriseKnowledgeGraph/2018-12-03/Microsoft.EnterpriseKnowledgeGraph.json create mode 100644 test/Resource/Expected/Microsoft.EventHub/2014-09-01/Microsoft.EventHub.json rename test/Resource/Expected/{EventHub => Microsoft.EventHub}/2015-08-01/Microsoft.EventHub.json (88%) rename test/Resource/Expected/{EventHub => Microsoft.EventHub}/2017-04-01/Microsoft.EventHub.json (70%) create mode 100644 test/Resource/Expected/Microsoft.EventHub/2018-01-01-preview/Microsoft.EventHub.json create mode 100644 test/Resource/Expected/Microsoft.IoTSpaces/2017-10-01-preview/Microsoft.IoTSpaces.json create mode 100644 test/Resource/Expected/Microsoft.LabServices/2018-10-15/Microsoft.LabServices.json create mode 100644 test/Resource/Expected/Microsoft.MachineLearningCompute/2017-06-01-preview/Microsoft.MachineLearningCompute.json create mode 100644 test/Resource/Expected/Microsoft.MachineLearningCompute/2017-08-01-preview/Microsoft.MachineLearningCompute.json create mode 100644 test/Resource/Expected/Microsoft.Portal/2015-08-01-preview/Microsoft.Portal.json create mode 100644 test/Resource/Expected/Microsoft.Portal/2018-10-01-preview/Microsoft.Portal.json create mode 100644 test/Resource/Expected/Microsoft.Portal/2019-01-01-preview/Microsoft.Portal.json rename test/Resource/Expected/{Relay => Microsoft.Relay}/2016-07-01/Microsoft.Relay.json (89%) rename test/Resource/Expected/{Relay => Microsoft.Relay}/2017-04-01/Microsoft.Relay.json (92%) rename test/Resource/Expected/{ServiceBus => Microsoft.ServiceBus}/2015-08-01/Microsoft.ServiceBus.json (88%) rename test/Resource/Expected/{ServiceBus => Microsoft.ServiceBus}/2017-04-01/Microsoft.ServiceBus.json (71%) create mode 100644 test/Resource/Expected/Microsoft.ServiceBus/2018-01-01-preview/Microsoft.ServiceBus.json rename test/Resource/Expected/{ServiceFabric => Microsoft.ServiceFabric}/2016-09-01/Microsoft.ServiceFabric.json (87%) rename test/Resource/Expected/{ServiceFabric => Microsoft.ServiceFabric}/2017-07-01-preview/Microsoft.ServiceFabric.json (77%) create mode 100644 test/Resource/Expected/Microsoft.ServiceFabric/2018-02-01/Microsoft.ServiceFabric.json create mode 100644 test/Resource/Expected/Microsoft.ServiceFabric/2019-03-01-preview/Microsoft.ServiceFabric.json create mode 100644 test/Resource/Expected/Microsoft.ServiceFabric/2019-03-01/Microsoft.ServiceFabric.json create mode 100644 test/Resource/Expected/Microsoft.ServiceFabricMesh/2018-07-01-preview/Microsoft.ServiceFabricMesh.json create mode 100644 test/Resource/Expected/Microsoft.ServiceFabricMesh/2018-09-01-preview/Microsoft.ServiceFabricMesh.json create mode 100644 test/Resource/Expected/Microsoft.SqlVirtualMachine/2017-03-01-preview/Microsoft.SqlVirtualMachine.json create mode 100644 test/Resource/Expected/Microsoft.StorageSync/2017-06-05-preview/Microsoft.StorageSync.json create mode 100644 test/Resource/Expected/Microsoft.StorageSync/2018-04-02/Microsoft.StorageSync.json create mode 100644 test/Resource/Expected/Microsoft.StorageSync/2018-07-01/Microsoft.StorageSync.json create mode 100644 test/Resource/Expected/Microsoft.StorageSync/2018-10-01/Microsoft.StorageSync.json create mode 100644 test/Resource/Expected/Microsoft.StorageSync/2019-02-01/Microsoft.StorageSync.json create mode 100644 test/Resource/Expected/Microsoft.StorageSync/2019-03-01/Microsoft.StorageSync.json create mode 100644 test/Resource/Expected/Microsoft.WindowsIoT/2018-02-16-preview/Microsoft.WindowsIoT.json create mode 100644 test/Resource/Expected/Microsoft.WindowsIoT/2019-06-01/Microsoft.WindowsIoT.json delete mode 100644 test/Resource/Expected/Monitor/2015-04-01/autoscalesettings.md delete mode 100644 test/Resource/Expected/Monitor/2015-04-01/microsoft.insights.json delete mode 100644 test/Resource/Expected/Monitor/2016-03-01/alertrules.md delete mode 100644 test/Resource/Expected/Monitor/2016-03-01/logprofiles.md delete mode 100644 test/Resource/Expected/Monitor/2016-03-01/microsoft.insights.json delete mode 100644 test/Resource/Expected/Monitor/2017-04-01/actionGroups.md delete mode 100644 test/Resource/Expected/Monitor/2017-04-01/activityLogAlerts.md delete mode 100644 test/Resource/Expected/Monitor/2017-04-01/microsoft.insights.json delete mode 100644 test/Resource/Expected/Monitor/2017-05-01-preview/diagnosticSettings.md delete mode 100644 test/Resource/Expected/Monitor/2017-05-01-preview/microsoft.insights.json delete mode 100644 test/Resource/Expected/Network/2016-03-30/Microsoft.Network.json delete mode 100644 test/Resource/Expected/Network/2016-03-30/applicationGateways.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/connections.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/expressRouteCircuits.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/expressRouteCircuits/authorizations.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/expressRouteCircuits/peerings.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/loadBalancers.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/localNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/networkInterfaces.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/networkSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/networkSecurityGroups/securityRules.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/publicIPAddresses.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/routeTables.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/routeTables/routes.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/virtualNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/virtualNetworks.md delete mode 100644 test/Resource/Expected/Network/2016-03-30/virtualNetworks/subnets.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/Microsoft.Network.json delete mode 100644 test/Resource/Expected/Network/2016-06-01/applicationGateways.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/connections.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/expressRouteCircuits.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/expressRouteCircuits/authorizations.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/expressRouteCircuits/peerings.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/loadBalancers.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/localNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/networkInterfaces.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/networkSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/networkSecurityGroups/securityRules.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/publicIPAddresses.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/routeTables.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/routeTables/routes.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/virtualNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/virtualNetworks.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/virtualNetworks/subnets.md delete mode 100644 test/Resource/Expected/Network/2016-06-01/virtualNetworks/virtualNetworkPeerings.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/Microsoft.Network.json delete mode 100644 test/Resource/Expected/Network/2016-09-01/applicationGateways.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/connections.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/expressRouteCircuits.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/expressRouteCircuits/authorizations.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/expressRouteCircuits/peerings.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/loadBalancers.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/localNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/networkInterfaces.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/networkSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/networkSecurityGroups/securityRules.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/networkWatchers.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/networkWatchers/packetCaptures.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/publicIPAddresses.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/routeTables.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/routeTables/routes.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/virtualNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/virtualNetworks.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/virtualNetworks/subnets.md delete mode 100644 test/Resource/Expected/Network/2016-09-01/virtualNetworks/virtualNetworkPeerings.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/Microsoft.Network.json delete mode 100644 test/Resource/Expected/Network/2016-12-01/applicationGateways.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/connections.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/expressRouteCircuits.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/expressRouteCircuits/authorizations.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/expressRouteCircuits/peerings.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/loadBalancers.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/localNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/networkInterfaces.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/networkSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/networkSecurityGroups/securityRules.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/networkWatchers.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/networkWatchers/packetCaptures.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/publicIPAddresses.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/routeFilters.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/routeFilters/routeFilterRules.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/routeTables.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/routeTables/routes.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/virtualNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/virtualNetworks.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/virtualNetworks/subnets.md delete mode 100644 test/Resource/Expected/Network/2016-12-01/virtualNetworks/virtualNetworkPeerings.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/Microsoft.Network.json delete mode 100644 test/Resource/Expected/Network/2017-03-01/applicationGateways.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/connections.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/expressRouteCircuits.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/expressRouteCircuits/authorizations.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/expressRouteCircuits/peerings.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/loadBalancers.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/localNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/networkInterfaces.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/networkSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/networkSecurityGroups/securityRules.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/networkWatchers.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/networkWatchers/packetCaptures.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/publicIPAddresses.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/routeFilters.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/routeFilters/routeFilterRules.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/routeTables.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/routeTables/routes.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/virtualNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/virtualNetworks.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/virtualNetworks/subnets.md delete mode 100644 test/Resource/Expected/Network/2017-03-01/virtualNetworks/virtualNetworkPeerings.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/Microsoft.Network.json delete mode 100644 test/Resource/Expected/Network/2017-06-01/applicationGateways.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/connections.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/expressRouteCircuits.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/expressRouteCircuits/authorizations.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/expressRouteCircuits/peerings.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/loadBalancers.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/loadBalancers/inboundNatRules.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/localNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/networkInterfaces.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/networkSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/networkSecurityGroups/securityRules.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/networkWatchers.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/networkWatchers/packetCaptures.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/publicIPAddresses.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/routeFilters.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/routeFilters/routeFilterRules.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/routeTables.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/routeTables/routes.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/virtualNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/virtualNetworks.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/virtualNetworks/subnets.md delete mode 100644 test/Resource/Expected/Network/2017-06-01/virtualNetworks/virtualNetworkPeerings.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/Microsoft.Network.json delete mode 100644 test/Resource/Expected/Network/2017-08-01/applicationGateways.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/connections.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/expressRouteCircuits.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/expressRouteCircuits/authorizations.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/expressRouteCircuits/peerings.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/loadBalancers.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/loadBalancers/inboundNatRules.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/localNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/networkInterfaces.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/networkSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/networkSecurityGroups/securityRules.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/networkWatchers.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/networkWatchers/packetCaptures.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/publicIPAddresses.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/routeFilters.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/routeFilters/routeFilterRules.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/routeTables.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/routeTables/routes.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/virtualNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/virtualNetworks.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/virtualNetworks/subnets.md delete mode 100644 test/Resource/Expected/Network/2017-08-01/virtualNetworks/virtualNetworkPeerings.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/Microsoft.Network.json delete mode 100644 test/Resource/Expected/Network/2017-09-01/applicationGateways.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/applicationSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/connections.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/expressRouteCircuits.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/expressRouteCircuits/authorizations.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/expressRouteCircuits/peerings.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/loadBalancers.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/loadBalancers/inboundNatRules.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/localNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/networkInterfaces.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/networkSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/networkSecurityGroups/securityRules.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/networkWatchers.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/networkWatchers/packetCaptures.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/publicIPAddresses.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/routeFilters.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/routeFilters/routeFilterRules.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/routeTables.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/routeTables/routes.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/virtualNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/virtualNetworks.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/virtualNetworks/subnets.md delete mode 100644 test/Resource/Expected/Network/2017-09-01/virtualNetworks/virtualNetworkPeerings.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/Microsoft.Network.json delete mode 100644 test/Resource/Expected/Network/2017-10-01/applicationGateways.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/applicationSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/connections.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/expressRouteCircuits.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/expressRouteCircuits/authorizations.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/expressRouteCircuits/peerings.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/loadBalancers.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/loadBalancers/inboundNatRules.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/localNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/networkInterfaces.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/networkSecurityGroups.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/networkSecurityGroups/securityRules.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/networkWatchers.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/networkWatchers/connectionMonitors.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/networkWatchers/packetCaptures.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/publicIPAddresses.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/routeFilters.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/routeFilters/routeFilterRules.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/routeTables.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/routeTables/routes.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/virtualNetworkGateways.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/virtualNetworks.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/virtualNetworks/subnets.md delete mode 100644 test/Resource/Expected/Network/2017-10-01/virtualNetworks/virtualNetworkPeerings.md delete mode 100644 test/Resource/Expected/RecoveryServices/2016-06-01/Microsoft.RecoveryServices.json delete mode 100644 test/Resource/Expected/RecoveryServices/2016-06-01/vaults.md delete mode 100644 test/Resource/Expected/RecoveryServices/2016-06-01/vaults/certificates.md delete mode 100644 test/Resource/Expected/Relay/2016-07-01/namespaces.md delete mode 100644 test/Resource/Expected/Relay/2016-07-01/namespaces/AuthorizationRules.md delete mode 100644 test/Resource/Expected/Relay/2016-07-01/namespaces/HybridConnections.md delete mode 100644 test/Resource/Expected/Relay/2016-07-01/namespaces/HybridConnections/authorizationRules.md delete mode 100644 test/Resource/Expected/Relay/2016-07-01/namespaces/WcfRelays.md delete mode 100644 test/Resource/Expected/Relay/2016-07-01/namespaces/WcfRelays/authorizationRules.md delete mode 100644 test/Resource/Expected/Relay/2017-04-01/namespaces.md delete mode 100644 test/Resource/Expected/Relay/2017-04-01/namespaces/authorizationRules.md delete mode 100644 test/Resource/Expected/Relay/2017-04-01/namespaces/hybridConnections.md delete mode 100644 test/Resource/Expected/Relay/2017-04-01/namespaces/hybridConnections/authorizationRules.md delete mode 100644 test/Resource/Expected/Relay/2017-04-01/namespaces/wcfRelays.md delete mode 100644 test/Resource/Expected/Relay/2017-04-01/namespaces/wcfRelays/authorizationRules.md delete mode 100644 test/Resource/Expected/ServiceBus/2015-08-01/namespaces.md delete mode 100644 test/Resource/Expected/ServiceBus/2015-08-01/namespaces/AuthorizationRules.md delete mode 100644 test/Resource/Expected/ServiceBus/2015-08-01/namespaces/queues.md delete mode 100644 test/Resource/Expected/ServiceBus/2015-08-01/namespaces/queues/authorizationRules.md delete mode 100644 test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics.md delete mode 100644 test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics/authorizationRules.md delete mode 100644 test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics/subscriptions.md delete mode 100644 test/Resource/Expected/ServiceBus/2017-04-01/namespaces.md delete mode 100644 test/Resource/Expected/ServiceBus/2017-04-01/namespaces/AuthorizationRules.md delete mode 100644 test/Resource/Expected/ServiceBus/2017-04-01/namespaces/disasterRecoveryConfigs.md delete mode 100644 test/Resource/Expected/ServiceBus/2017-04-01/namespaces/queues.md delete mode 100644 test/Resource/Expected/ServiceBus/2017-04-01/namespaces/queues/authorizationRules.md delete mode 100644 test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics.md delete mode 100644 test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/authorizationRules.md delete mode 100644 test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/subscriptions.md delete mode 100644 test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/subscriptions/rules.md delete mode 100644 test/Resource/Expected/ServiceFabric/2016-09-01/clusters.md delete mode 100644 test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters.md delete mode 100644 test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applicationTypes.md delete mode 100644 test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applicationTypes/versions.md delete mode 100644 test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applications.md delete mode 100644 test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applications/services.md delete mode 100644 test/Resource/Expected/Storage/2015-05-01-preview/Microsoft.Storage.json delete mode 100644 test/Resource/Expected/Storage/2015-05-01-preview/storageAccounts.md delete mode 100644 test/Resource/Expected/Storage/2015-06-15/Microsoft.Storage.json delete mode 100644 test/Resource/Expected/Storage/2015-06-15/storageAccounts.md delete mode 100644 test/Resource/Expected/Storage/2016-01-01/Microsoft.Storage.json delete mode 100644 test/Resource/Expected/Storage/2016-01-01/storageAccounts.md delete mode 100644 test/Resource/Expected/Storage/2016-05-01/Microsoft.Storage.json delete mode 100644 test/Resource/Expected/Storage/2016-05-01/storageAccounts.md delete mode 100644 test/Resource/Expected/Storage/2016-12-01/Microsoft.Storage.json delete mode 100644 test/Resource/Expected/Storage/2016-12-01/storageAccounts.md delete mode 100644 test/Resource/Expected/Storage/2017-06-01/Microsoft.Storage.json delete mode 100644 test/Resource/Expected/Storage/2017-06-01/storageAccounts.md delete mode 100644 test/Resource/Expected/Storage/2017-10-01/Microsoft.Storage.json delete mode 100644 test/Resource/Expected/Storage/2017-10-01/storageAccounts.md delete mode 100644 test/Resource/Expected/TimeSeriesInsights/2017-11-15/Microsoft.TimeSeriesInsights.json delete mode 100644 test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments.md delete mode 100644 test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/accessPolicies.md delete mode 100644 test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/eventSources.md delete mode 100644 test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/referenceDataSets.md delete mode 100644 test/Resource/Expected/Web/2015-04-01/Microsoft.DomainRegistration.json delete mode 100644 test/Resource/Expected/Web/2015-04-01/domains.md delete mode 100644 test/Resource/Expected/Web/2015-04-01/domains/domainOwnershipIdentifiers.md delete mode 100644 test/Resource/Expected/Web/2015-08-01/Microsoft.CertificateRegistration.json delete mode 100644 test/Resource/Expected/Web/2015-08-01/certificateOrders.md delete mode 100644 test/Resource/Expected/Web/2015-08-01/certificateOrders/certificates.md delete mode 100644 test/Resource/Expected/Web/2016-03-01/Microsoft.Web.json delete mode 100644 test/Resource/Expected/Web/2016-03-01/certificates.md delete mode 100644 test/Resource/Expected/Web/2016-03-01/sourcecontrols.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/Microsoft.Web.json delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/deployments.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/domainOwnershipIdentifiers.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/functions.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/hostNameBindings.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/hybridConnectionNamespaces/relays.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/hybridconnection.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/premieraddons.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/publicCertificates.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/siteextensions.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/deployments.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/domainOwnershipIdentifiers.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/functions.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/hostNameBindings.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/hybridConnectionNamespaces/relays.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/hybridconnection.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/premieraddons.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/publicCertificates.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/siteextensions.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/virtualNetworkConnections.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/slots/virtualNetworkConnections/gateways.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/virtualNetworkConnections.md delete mode 100644 test/Resource/Expected/Web/2016-08-01/sites/virtualNetworkConnections/gateways.md delete mode 100644 test/Resource/Expected/Web/2016-09-01/Microsoft.Web.json delete mode 100644 test/Resource/Expected/Web/2016-09-01/hostingEnvironments.md delete mode 100644 test/Resource/Expected/Web/2016-09-01/hostingEnvironments/workerPools.md delete mode 100644 test/Resource/Expected/Web/2016-09-01/serverfarms.md delete mode 100644 test/Resource/Expected/Web/2016-09-01/serverfarms/virtualNetworkConnections/gateways.md delete mode 100644 test/Resource/Expected/Web/2016-09-01/serverfarms/virtualNetworkConnections/routes.md diff --git a/.gulp/common.iced b/.gulp/common.iced index 81b136f..9e84151 100644 --- a/.gulp/common.iced +++ b/.gulp/common.iced @@ -368,7 +368,7 @@ module.exports = autorest: (args,done,ignoreexitcode) -> echo info "Queuing up: AutoRest #{args.join(' ')}" - execute "#{basefolder}/node_modules/.bin/autorest \"--use=#{basefolder}\" #{args.map((a) -> "\"#{a}\"").join(' ')}" , { silent:true, ignoreexitcode: ignoreexitcode || false }, (code,stdout,stderr) -> + execute "#{basefolder}/node_modules/.bin/autorest-beta \"--use=#{basefolder}\" #{args.map((a) -> "\"#{a}\"").join(' ')}" , { silent:true, ignoreexitcode: ignoreexitcode || false }, (code,stdout,stderr) -> return done(code,stdout,stderr) # build task for global build @@ -472,28 +472,28 @@ task 'fix-line-endings', 'Fixes line endings to file-type appropriate values.', .pipe eol {eolc: 'LF', encoding:'utf8'} .pipe destination '.' -task 'get-tag', '!', (done)-> - if argv.tag - # take the argument if they specified it. - global.tag = argv.tag - done() - else - # pick up the tag from the pkg.json version entry - global.tag = semver.parse((package_json.version).trim()).prerelease.join(".") - if( global.tag ) - return done() - - # if branch is provided by environment - if( env.BUILD_SOURCEBRANCHNAME ) - global.tag = if ( env.BUILD_SOURCEBRANCHNAME == "master" || env.BUILD_SOURCEBRANCHNAME =="HEAD" ) then "preview" else env.BUILD_SOURCEBRANCHNAME - return done(); - - # grab the git branch name. - execute "git rev-parse --abbrev-ref HEAD" , {silent:true}, (c,o,e)-> - o = "preview" if( o == undefined || o == null || o == "" || o.trim() == 'master' || o.trim() == 'HEAD') - global.tag = o.trim() - done(); - +task 'get-tag', '!', (done)-> + if argv.tag + # take the argument if they specified it. + global.tag = argv.tag + done() + else + # pick up the tag from the pkg.json version entry + global.tag = semver.parse((package_json.version).trim()).prerelease.join(".") + if( global.tag ) + return done() + + # if branch is provided by environment + if( env.BUILD_SOURCEBRANCHNAME ) + global.tag = if ( env.BUILD_SOURCEBRANCHNAME == "master" || env.BUILD_SOURCEBRANCHNAME =="HEAD" ) then "preview" else env.BUILD_SOURCEBRANCHNAME + return done(); + + # grab the git branch name. + execute "git rev-parse --abbrev-ref HEAD" , {silent:true}, (c,o,e)-> + o = "preview" if( o == undefined || o == null || o == "" || o.trim() == 'master' || o.trim() == 'HEAD') + global.tag = o.trim() + done(); + task 'version-number', '!', (done)-> if argv.version global.version = argv.version if argv.version diff --git a/.gulp/regeneration.iced b/.gulp/regeneration.iced index 8f6ad29..3c0bfab 100644 --- a/.gulp/regeneration.iced +++ b/.gulp/regeneration.iced @@ -12,18 +12,17 @@ regenExpected = (opts,done) -> key = kkey.trim(); args = [ - "--#{opts.language}.output-folder=#{__dirname}/../#{opts.outputDir}/#{key}", - "--title=title" + "--#{opts.language}.multi-scope=true", + "--output-folder=#{__dirname}/../#{opts.outputDir}/#{key}", + "--tag=all-api-versions", + "--title=none" ] - if value.file - args.push("--input-file=#{value.file}") - else - args.push("#{opts.inputBaseDir}/#{value.folder}/resource-manager/readme.md") + args.push("#{opts.inputBaseDir}/#{value.basePath}/readme.md") - for tag in value.tags + for apiVersion in value.apiVersions args2 = args.slice() - args2.push("--tag=#{tag}") + args2.push("--api-version=#{apiVersion}") autorest args2,() => instances-- return done() if instances is 0 @@ -31,51 +30,27 @@ regenExpected = (opts,done) -> task 'regenerate', '', (done) -> regenExpected { 'outputDir': 'test/Resource/Expected', - 'inputBaseDir': 'https://github.com/Azure/azure-rest-api-specs/blob/ee4507de8c2ba506fb8a7a9decff67691ed4d336/specification', + 'inputBaseDir': 'https://github.com/Azure/azure-rest-api-specs/blob/f1fdf4a5adfb067c78e4625e293ad4bbc97789c7/specification', 'mappings': { - # 'Advisor': { folder: 'advisor', tags: [ 'package-2017-04', 'package-2017-03', 'package-2016-07-preview' ] }, - 'AnalysisServices': { folder: 'analysisservices', tags: [ 'package-2017-08-beta', 'package-2017-07', 'package-2016-05' ] }, - 'ApiManagement': { folder: 'apimanagement', tags: [ 'package-2017-03', 'package-2016-10' ] }, - # 'ApplicationInsights': { folder: 'applicationinsights', tags: [ 'package-2015-05' ] }, - # 'Authorization': { folder: 'authorization', tags: [ 'package-2015-07', 'package-2017-10-01-preview' ] }, - 'Automation': { folder: 'automation', tags: [ 'package-2015-10', 'package-2017-05-preview' ] }, - 'Batch': { folder: 'batch', tags: [ 'package-2017-09', 'package-2017-05', 'package-2017-01', 'package-2015-12' ] }, - # 'CDN': { folder: 'cdn', tags: [ 'package-2017-04', 'package-2016-10', 'package-2016-04', 'package-2015-06' ] }, - # 'CognitiveServices': { folder: 'cognitiveservices', tags: [ 'package-2017-04', 'package-2016-02-preview' ] }, - 'Compute': { folder: 'compute', tags: [ 'package-compute-only-2017-12', 'package-skus-2017-09', 'package-2017-03', 'package-2016-04-preview', 'package-2016-03', 'package-2015-06-preview' ] }, - # 'Consumption': { folder: 'consumption', tags: [ 'package-2017-11', 'package-2017-04-preview', 'package-2017-12-preview' ] }, - 'ContainerRegistry': { folder: 'containerregistry', tags: [ 'package-2017-10', 'package-2017-06-preview', 'package-2017-03', 'package-2016-06-preview' ] }, - # 'ContainerService': { folder: 'containerservices', tags: [ 'package-2017-09', 'package-2017-08', 'package-2017-07' ] }, - 'CustomerInsights': { folder: 'customer-insights', tags: [ 'package-2017-04', 'package-2017-01' ] }, - # 'DataLakeAnalytics': { folder: 'datalake-analytics', tags: [ 'package-2016-11', 'package-2015-10-preview' ] }, - # 'DataLakeStore': { folder: 'datalake-store', tags: [ 'package-2016-11', 'package-2015-10-preview' ] }, - 'DevTestLabs': { folder: 'devtestlabs', tags: [ 'package-2016-05', 'package-2015-05-preview' ] }, - # 'DNS': { folder: 'dns', tags: [ 'package-2017-09', 'package-2016-04', 'package-2015-05-preview' ] }, - # 'DomainServices': { folder: 'domainservices', tags: [ 'package-2017-06', 'package-2017-01' ] }, - 'EventGrid': { folder: 'eventgrid', tags: [ 'package-2018-01', 'package-2017-09-preview', 'package-2017-06-preview' ] }, - 'EventHub': { folder: 'eventhub', tags: [ 'package-2017-04', 'package-2015-08' ] }, - # 'IotHub': { folder: 'iothub', tags: [ 'package-2017-07', 'package-2017-01', 'package-2016-02' ] }, - # 'KeyVault': { folder: 'keyvault', tags: [ 'package-2016-10', 'package-2015-06' ] }, - 'Logic': { folder: 'logic', tags: [ 'package-2016-06', 'package-2015-08-preview', 'package-2015-02-preview' ] }, # missing 'type: object' - 'Monitor': { folder: 'monitor', tags: [ 'package-2017-08', 'package-2017-09' ] } - 'Network': { folder: 'network', tags: [ 'package-2017-10', 'package-2017-09', 'package-2017-08', 'package-2017-06', 'package-2017-03', 'package-2016-12', 'package-2016-09', 'package-2016-06', 'package-2016-03' ] }, - # 'NotificationHubs': { folder: 'notificationhubs', tags: [ 'package-2017-04', 'package-2016-03', 'package-2014-09' ] }, - # 'PowerBIEmbedded': { folder: 'powerbiembedded', tags: [ 'package-2016-01' ] }, - # 'ProvisioningServices': { folder: 'provisioningservices', tags: [ 'package-2017-08', 'package-2017-11' ] }, - 'RecoveryServices': { folder: 'recoveryservices', tags: [ 'package-2016-12', 'package-2016-06' ] }, - # 'RecoveryServicesBackup': { folder: 'recoveryservicesbackup', tags: [ 'package-2017-07', 'package-2016-06' ] }, - # 'Redis': { folder: 'redis', tags: [ 'package-2017-10', 'package-2017-02', 'package-2016-04', 'package-2015-08' ] }, - 'Relay': { folder: 'relay', tags: [ 'package-2017-04', 'package-2016-07' ] }, - # 'Reservations': { folder: 'reservations', tags: [ 'package-2017-11' ] }, - # 'Scheduler': { folder: 'scheduler', tags: [ 'package-2016-03', 'package-2016-01', 'package-2014-08-preview' ] }, - # 'Search': { folder: 'search', tags: [ 'package-2015-08', 'package-2015-02' ] }, - 'ServiceBus': { folder: 'servicebus', tags: [ 'package-2017-04', 'package-2015-08' ] }, - 'ServiceFabric': { folder: 'servicefabric', tags: [ 'package-2017-07', 'package-2016-09' ] }, # missing 'type: object' - 'Storage': { folder: 'storage', tags: [ 'package-2017-10', 'package-2017-06', 'package-2016-12', 'package-2016-05', 'package-2016-01', 'package-2015-06', 'package-2015-05-preview' ] }, - # 'TrafficManager': { folder: 'trafficmanager', tags: [ 'package-2017-09-preview', 'package-2017-05', 'package-2017-03', 'package-2015-11' ] }, - 'TimeSeriesInsights': { folder: 'timeseriesinsights', tags: [ 'package-2017-11-15' ] }, - 'Web': { folder: 'web', tags: [ 'package-2016-09' ] }, # missing 'type: object' - # 'poly': { file: __dirname + "/../test/Resource/poly-service.json", tags: [ '' ] } + 'Microsoft.BotService': { basePath: 'botservice/resource-manager', apiVersions: [ '2017-12-01', '2018-07-12' ] }, + 'Microsoft.DataBox': { basePath: 'databox/resource-manager', apiVersions: [ '2018-01-01' ] }, + 'Microsoft.DataBoxEdge': { basePath: 'databoxedge/resource-manager', apiVersions: [ '2019-03-01', '2019-07-01' ] }, + 'Microsoft.Databricks': { basePath: 'databricks/resource-manager', apiVersions: [ '2018-04-01' ] }, + 'Microsoft.DevSpaces': { basePath: 'devspaces/resource-manager', apiVersions: [ '2019-04-01' ] }, + 'Microsoft.DocumentDB': { basePath: 'cosmos-db/resource-manager', apiVersions: [ '2015-04-08', '2019-08-01' ] }, + 'Microsoft.EnterpriseKnowledgeGraph': { basePath: 'EnterpriseKnowledgeGraph/resource-manager', apiVersions: [ '2018-12-03' ] }, + 'Microsoft.EventHub': { basePath: 'eventhub/resource-manager', apiVersions: [ '2014-09-01', '2015-08-01', '2017-04-01', '2018-01-01-preview' ] }, + 'Microsoft.IoTSpaces': { basePath: 'iotspaces/resource-manager', apiVersions: [ '2017-10-01-preview' ] }, + 'Microsoft.LabServices': { basePath: 'labservices/resource-manager', apiVersions: [ '2018-10-15' ] }, + 'Microsoft.MachineLearningCompute': { basePath: 'machinelearningcompute/resource-manager', apiVersions: [ '2017-06-01-preview', '2017-08-01-preview' ] }, + 'Microsoft.Portal': { basePath: 'portal/resource-manager', apiVersions: [ '2015-08-01-preview', '2018-10-01-preview', '2019-01-01-preview' ] }, + 'Microsoft.Relay': { basePath: 'relay/resource-manager', apiVersions: [ '2016-07-01', '2017-04-01' ] }, + 'Microsoft.ServiceBus': { basePath: 'servicebus/resource-manager', apiVersions: [ '2015-08-01', '2017-04-01', '2018-01-01-preview' ] }, + 'Microsoft.ServiceFabric': { basePath: 'servicefabric/resource-manager', apiVersions: [ '2016-09-01', '2017-07-01-preview', '2018-02-01', '2019-03-01', '2019-03-01-preview' ] }, + 'Microsoft.ServiceFabricMesh': { basePath: 'servicefabricmesh/resource-manager', apiVersions: [ '2018-07-01-preview', '2018-09-01-preview' ] }, + 'Microsoft.SqlVirtualMachine': { basePath: 'sqlvirtualmachine/resource-manager', apiVersions: [ '2017-03-01-preview' ] }, + 'Microsoft.StorageSync': { basePath: 'storagesync/resource-manager', apiVersions: [ '2017-06-05-preview', '2018-04-02', '2018-07-01', '2018-10-01', '2019-02-01', '2019-03-01' ] }, + 'Microsoft.WindowsIoT': { basePath: 'windowsiot/resource-manager', apiVersions: [ '2018-02-16-preview', '2019-06-01' ] }, }, 'language': 'azureresourceschema' },done diff --git a/package.json b/package.json index acc9946..833c8da 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,7 @@ }, "homepage": "https://github.com/Azure/autorest.azureresourceschema/blob/master/README.md", "devDependencies": { - "autorest": "^2.0.4203", + "@autorest/autorest": "^3.0.6113", "coffee-script": "^1.11.1", "dotnet-sdk-2.0.0": "^1.4.4", "gulp": "^3.9.1", @@ -51,4 +51,4 @@ "dependencies": { "dotnet-2.0.0": "^1.4.4" } -} \ No newline at end of file +} diff --git a/test/Resource/Expected/AnalysisServices/2016-05-16/Microsoft.AnalysisServices.json b/test/Resource/Expected/AnalysisServices/2016-05-16/Microsoft.AnalysisServices.json deleted file mode 100644 index 2180320..0000000 --- a/test/Resource/Expected/AnalysisServices/2016-05-16/Microsoft.AnalysisServices.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-05-16/Microsoft.AnalysisServices.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.AnalysisServices", - "description": "Microsoft AnalysisServices Resource Types", - "resourceDefinitions": { - "servers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.AnalysisServices/servers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-16" - ] - }, - "location": { - "type": "string", - "description": "Location of the Analysis Services resource." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU of the Analysis Services resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key-value pairs of additional resource provisioning properties." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AnalysisServicesServerProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the provision operation request." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "sku", - "properties" - ], - "description": "Microsoft.AnalysisServices/servers" - } - }, - "definitions": { - "AnalysisServicesServerProperties": { - "type": "object", - "properties": { - "asAdministrators": { - "oneOf": [ - { - "$ref": "#/definitions/ServerAdministrators" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of AS server administrators" - }, - "backupBlobContainerUri": { - "type": "string", - "description": "The container URI of backup blob." - } - }, - "description": "Properties of Analysis Services resource." - }, - "ResourceSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the SKU level." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Development", - "Basic", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the Azure pricing tier to which the SKU applies." - } - }, - "required": [ - "name" - ], - "description": "Represents the SKU name and Azure pricing tier for Analysis Services resource." - }, - "ServerAdministrators": { - "type": "object", - "properties": { - "members": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An array of administrator user identities." - } - }, - "description": "An array of administrator user identities" - } - } -} diff --git a/test/Resource/Expected/AnalysisServices/2016-05-16/servers.md b/test/Resource/Expected/AnalysisServices/2016-05-16/servers.md deleted file mode 100644 index 2455848..0000000 --- a/test/Resource/Expected/AnalysisServices/2016-05-16/servers.md +++ /dev/null @@ -1,66 +0,0 @@ -# Microsoft.AnalysisServices/servers template reference -API Version: 2016-05-16 -## Template format - -To create a Microsoft.AnalysisServices/servers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.AnalysisServices/servers", - "apiVersion": "2016-05-16", - "location": "string", - "sku": { - "name": "string", - "tier": "string" - }, - "tags": {}, - "properties": { - "asAdministrators": { - "members": [ - "string" - ] - }, - "backupBlobContainerUri": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.AnalysisServices/servers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.AnalysisServices/servers | -| apiVersion | enum | Yes | 2016-05-16 | -| location | string | Yes | Location of the Analysis Services resource. | -| sku | object | Yes | The SKU of the Analysis Services resource. - [ResourceSku object](#ResourceSku) | -| tags | object | No | Key-value pairs of additional resource provisioning properties. | -| properties | object | Yes | Properties of the provision operation request. - [AnalysisServicesServerProperties object](#AnalysisServicesServerProperties) | - - - -### ResourceSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Name of the SKU level. | -| tier | enum | No | The name of the Azure pricing tier to which the SKU applies. - Development, Basic, Standard | - - - -### AnalysisServicesServerProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asAdministrators | object | No | A collection of AS server administrators - [ServerAdministrators object](#ServerAdministrators) | -| backupBlobContainerUri | string | No | The container URI of backup blob. | - - - -### ServerAdministrators object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| members | array | No | An array of administrator user identities. - string | - diff --git a/test/Resource/Expected/AnalysisServices/2017-07-14/Microsoft.AnalysisServices.json b/test/Resource/Expected/AnalysisServices/2017-07-14/Microsoft.AnalysisServices.json deleted file mode 100644 index 066b8ee..0000000 --- a/test/Resource/Expected/AnalysisServices/2017-07-14/Microsoft.AnalysisServices.json +++ /dev/null @@ -1,171 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-07-14/Microsoft.AnalysisServices.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.AnalysisServices", - "description": "Microsoft AnalysisServices Resource Types", - "resourceDefinitions": { - "servers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.AnalysisServices/servers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-07-14" - ] - }, - "location": { - "type": "string", - "description": "Location of the Analysis Services resource." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU of the Analysis Services resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key-value pairs of additional resource provisioning properties." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AnalysisServicesServerProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the provision operation request." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "sku", - "properties" - ], - "description": "Microsoft.AnalysisServices/servers" - } - }, - "definitions": { - "AnalysisServicesServerProperties": { - "type": "object", - "properties": { - "asAdministrators": { - "oneOf": [ - { - "$ref": "#/definitions/ServerAdministrators" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of AS server administrators" - }, - "backupBlobContainerUri": { - "type": "string", - "description": "The SAS container URI to the backup container." - }, - "gatewayDetails": { - "oneOf": [ - { - "$ref": "#/definitions/GatewayDetails" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The gateway details configured for the AS server." - } - }, - "description": "Properties of Analysis Services resource." - }, - "GatewayDetails": { - "type": "object", - "properties": { - "gatewayResourceId": { - "type": "string", - "description": "Gateway resource to be associated with the server." - } - }, - "description": "The gateway details." - }, - "ResourceSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the SKU level." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Development", - "Basic", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the Azure pricing tier to which the SKU applies." - } - }, - "required": [ - "name" - ], - "description": "Represents the SKU name and Azure pricing tier for Analysis Services resource." - }, - "ServerAdministrators": { - "type": "object", - "properties": { - "members": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An array of administrator user identities." - } - }, - "description": "An array of administrator user identities" - } - } -} diff --git a/test/Resource/Expected/AnalysisServices/2017-07-14/servers.md b/test/Resource/Expected/AnalysisServices/2017-07-14/servers.md deleted file mode 100644 index cfdcca9..0000000 --- a/test/Resource/Expected/AnalysisServices/2017-07-14/servers.md +++ /dev/null @@ -1,77 +0,0 @@ -# Microsoft.AnalysisServices/servers template reference -API Version: 2017-07-14 -## Template format - -To create a Microsoft.AnalysisServices/servers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.AnalysisServices/servers", - "apiVersion": "2017-07-14", - "location": "string", - "sku": { - "name": "string", - "tier": "string" - }, - "tags": {}, - "properties": { - "asAdministrators": { - "members": [ - "string" - ] - }, - "backupBlobContainerUri": "string", - "gatewayDetails": { - "gatewayResourceId": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.AnalysisServices/servers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.AnalysisServices/servers | -| apiVersion | enum | Yes | 2017-07-14 | -| location | string | Yes | Location of the Analysis Services resource. | -| sku | object | Yes | The SKU of the Analysis Services resource. - [ResourceSku object](#ResourceSku) | -| tags | object | No | Key-value pairs of additional resource provisioning properties. | -| properties | object | Yes | Properties of the provision operation request. - [AnalysisServicesServerProperties object](#AnalysisServicesServerProperties) | - - - -### ResourceSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Name of the SKU level. | -| tier | enum | No | The name of the Azure pricing tier to which the SKU applies. - Development, Basic, Standard | - - - -### AnalysisServicesServerProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asAdministrators | object | No | A collection of AS server administrators - [ServerAdministrators object](#ServerAdministrators) | -| backupBlobContainerUri | string | No | The SAS container URI to the backup container. | -| gatewayDetails | object | No | The gateway details configured for the AS server. - [GatewayDetails object](#GatewayDetails) | - - - -### ServerAdministrators object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| members | array | No | An array of administrator user identities. - string | - - - -### GatewayDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| gatewayResourceId | string | No | Gateway resource to be associated with the server. | - diff --git a/test/Resource/Expected/AnalysisServices/2017-08-01-beta/Microsoft.AnalysisServices.json b/test/Resource/Expected/AnalysisServices/2017-08-01-beta/Microsoft.AnalysisServices.json deleted file mode 100644 index fd9c242..0000000 --- a/test/Resource/Expected/AnalysisServices/2017-08-01-beta/Microsoft.AnalysisServices.json +++ /dev/null @@ -1,253 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-08-01-beta/Microsoft.AnalysisServices.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.AnalysisServices", - "description": "Microsoft AnalysisServices Resource Types", - "resourceDefinitions": { - "servers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.AnalysisServices/servers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01-beta" - ] - }, - "location": { - "type": "string", - "description": "Location of the Analysis Services resource." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU of the Analysis Services resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key-value pairs of additional resource provisioning properties." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AnalysisServicesServerProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the provision operation request." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "sku", - "properties" - ], - "description": "Microsoft.AnalysisServices/servers" - } - }, - "definitions": { - "AnalysisServicesServerProperties": { - "type": "object", - "properties": { - "asAdministrators": { - "oneOf": [ - { - "$ref": "#/definitions/ServerAdministrators" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of AS server administrators" - }, - "backupBlobContainerUri": { - "type": "string", - "description": "The SAS container URI to the backup container." - }, - "gatewayDetails": { - "oneOf": [ - { - "$ref": "#/definitions/GatewayDetails" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The gateway details configured for the AS server." - }, - "ipV4FirewallSettings": { - "oneOf": [ - { - "$ref": "#/definitions/IPv4FirewallSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The firewall settings for the AS server." - }, - "querypoolConnectionMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "All", - "ReadOnly" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "How the read-write server's participation in the query pool is controlled.
It can have the following values: Specifying readOnly when capacity is 1 results in error." - } - }, - "description": "Properties of Analysis Services resource." - }, - "GatewayDetails": { - "type": "object", - "properties": { - "gatewayResourceId": { - "type": "string", - "description": "Gateway resource to be associated with the server." - } - }, - "description": "The gateway details." - }, - "IPv4FirewallRule": { - "type": "object", - "properties": { - "firewallRuleName": { - "type": "string", - "description": "The rule name." - }, - "rangeStart": { - "type": "string", - "description": "The start range of IPv4." - }, - "rangeEnd": { - "type": "string", - "description": "The end range of IPv4." - } - }, - "description": "The detail of firewall rule." - }, - "IPv4FirewallSettings": { - "type": "object", - "properties": { - "firewallRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IPv4FirewallRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An array of firewall rules." - }, - "enablePowerBIService": { - "type": "string", - "description": "The indicator of enableing PBI service." - } - }, - "description": "An array of firewall rules." - }, - "ResourceSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the SKU level." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Development", - "Basic", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the Azure pricing tier to which the SKU applies." - }, - "capacity": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 8, - "default": "1" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of instances in the read only query pool." - } - }, - "required": [ - "name" - ], - "description": "Represents the SKU name and Azure pricing tier for Analysis Services resource." - }, - "ServerAdministrators": { - "type": "object", - "properties": { - "members": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An array of administrator user identities." - } - }, - "description": "An array of administrator user identities." - } - } -} diff --git a/test/Resource/Expected/AnalysisServices/2017-08-01-beta/servers.md b/test/Resource/Expected/AnalysisServices/2017-08-01-beta/servers.md deleted file mode 100644 index 4a37b16..0000000 --- a/test/Resource/Expected/AnalysisServices/2017-08-01-beta/servers.md +++ /dev/null @@ -1,109 +0,0 @@ -# Microsoft.AnalysisServices/servers template reference -API Version: 2017-08-01-beta -## Template format - -To create a Microsoft.AnalysisServices/servers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.AnalysisServices/servers", - "apiVersion": "2017-08-01-beta", - "location": "string", - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "tags": {}, - "properties": { - "asAdministrators": { - "members": [ - "string" - ] - }, - "backupBlobContainerUri": "string", - "gatewayDetails": { - "gatewayResourceId": "string" - }, - "ipV4FirewallSettings": { - "firewallRules": [ - { - "firewallRuleName": "string", - "rangeStart": "string", - "rangeEnd": "string" - } - ], - "enablePowerBIService": "string" - }, - "querypoolConnectionMode": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.AnalysisServices/servers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.AnalysisServices/servers | -| apiVersion | enum | Yes | 2017-08-01-beta | -| location | string | Yes | Location of the Analysis Services resource. | -| sku | object | Yes | The SKU of the Analysis Services resource. - [ResourceSku object](#ResourceSku) | -| tags | object | No | Key-value pairs of additional resource provisioning properties. | -| properties | object | Yes | Properties of the provision operation request. - [AnalysisServicesServerProperties object](#AnalysisServicesServerProperties) | - - - -### ResourceSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Name of the SKU level. | -| tier | enum | No | The name of the Azure pricing tier to which the SKU applies. - Development, Basic, Standard | -| capacity | integer | No | The number of instances in the read only query pool. | - - - -### AnalysisServicesServerProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asAdministrators | object | No | A collection of AS server administrators - [ServerAdministrators object](#ServerAdministrators) | -| backupBlobContainerUri | string | No | The SAS container URI to the backup container. | -| gatewayDetails | object | No | The gateway details configured for the AS server. - [GatewayDetails object](#GatewayDetails) | -| ipV4FirewallSettings | object | No | The firewall settings for the AS server. - [IPv4FirewallSettings object](#IPv4FirewallSettings) | -| querypoolConnectionMode | enum | No | How the read-write server's participation in the query pool is controlled.
It can have the following values: Specifying readOnly when capacity is 1 results in error. - All or ReadOnly | - - - -### ServerAdministrators object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| members | array | No | An array of administrator user identities. - string | - - - -### GatewayDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| gatewayResourceId | string | No | Gateway resource to be associated with the server. | - - - -### IPv4FirewallSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| firewallRules | array | No | An array of firewall rules. - [IPv4FirewallRule object](#IPv4FirewallRule) | -| enablePowerBIService | string | No | The indicator of enableing PBI service. | - - - -### IPv4FirewallRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| firewallRuleName | string | No | The rule name. | -| rangeStart | string | No | The start range of IPv4. | -| rangeEnd | string | No | The end range of IPv4. | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/Microsoft.ApiManagement.json b/test/Resource/Expected/ApiManagement/2016-10-10/Microsoft.ApiManagement.json deleted file mode 100644 index d0e2cff..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/Microsoft.ApiManagement.json +++ /dev/null @@ -1,3073 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-10-10/Microsoft.ApiManagement.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.ApiManagement", - "description": "Microsoft ApiManagement Resource Types", - "resourceDefinitions": { - "service": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the API Management service." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApiManagementServiceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the API Management service." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApiManagementServiceSkuProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU properties of the API Management service." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_apis_childResource" - }, - { - "$ref": "#/definitions/service_authorizationServers_childResource" - }, - { - "$ref": "#/definitions/service_backends_childResource" - }, - { - "$ref": "#/definitions/service_certificates_childResource" - }, - { - "$ref": "#/definitions/service_groups_childResource" - }, - { - "$ref": "#/definitions/service_identityProviders_childResource" - }, - { - "$ref": "#/definitions/service_loggers_childResource" - }, - { - "$ref": "#/definitions/service_openidConnectProviders_childResource" - }, - { - "$ref": "#/definitions/service_products_childResource" - }, - { - "$ref": "#/definitions/service_properties_childResource" - }, - { - "$ref": "#/definitions/service_subscriptions_childResource" - }, - { - "$ref": "#/definitions/service_users_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties", - "sku" - ], - "description": "Microsoft.ApiManagement/service" - }, - "service_apis": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "API identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/apis" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "Description of the API. May include HTML formatting tags." - }, - "authenticationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AuthenticationSettingsContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of authentication settings included into this API." - }, - "subscriptionKeyParameterNames": { - "oneOf": [ - { - "$ref": "#/definitions/SubscriptionKeyParameterNamesContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocols over which API is made available." - }, - "serviceUrl": { - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Absolute URL of the backend service implementing this API." - }, - "path": { - "type": "string", - "minLength": 0, - "maxLength": 400, - "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API." - }, - "protocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Http", - "Https" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Describes on which protocols the operations in this API can be invoked." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_apis_operations_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "serviceUrl", - "path", - "protocols" - ], - "description": "Microsoft.ApiManagement/service/apis" - }, - "service_apis_operations": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Operation identifier within an API. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/apis/operations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "templateParameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of URL template parameters." - }, - "description": { - "type": "string", - "maxLength": 1000, - "description": "Description of the operation. May include HTML formatting tags." - }, - "request": { - "oneOf": [ - { - "$ref": "#/definitions/RequestContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An entity containing request details." - }, - "responses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResultContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of Operation responses." - }, - "method": { - "type": "string", - "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them." - }, - "urlTemplate": { - "type": "string", - "minLength": 1, - "maxLength": 1000, - "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "method", - "urlTemplate" - ], - "description": "Microsoft.ApiManagement/service/apis/operations" - }, - "service_authorizationServers": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the authorization server." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/authorizationServers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "Description of the authorization server. Can contain HTML formatting tags." - }, - "clientRegistrationEndpoint": { - "type": "string", - "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." - }, - "authorizationEndpoint": { - "type": "string", - "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." - }, - "authorizationMethods": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "HEAD", - "OPTIONS", - "TRACE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional." - }, - "clientAuthenticationMethod": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Basic", - "Body" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format." - }, - "tokenBodyParameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/TokenBodyParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "OAuth token endpoint. Contains absolute URI to entity being referenced." - }, - "supportState": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security." - }, - "defaultScope": { - "type": "string", - "description": "Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values." - }, - "grantTypes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationCode", - "implicit", - "resourceOwnerPassword", - "clientCredentials" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Form of an authorization grant, which the client uses to request the access token." - }, - "bearerTokenSendingMethods": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationHeader", - "query" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the mechanism by which access token is passed to the API. " - }, - "clientId": { - "type": "string", - "description": "Client or app id registered with this authorization server." - }, - "clientSecret": { - "type": "string", - "description": "Client or app secret registered with this authorization server." - }, - "resourceOwnerUsername": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." - }, - "resourceOwnerPassword": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "clientRegistrationEndpoint", - "authorizationEndpoint", - "grantTypes", - "clientId" - ], - "description": "Microsoft.ApiManagement/service/authorizationServers" - }, - "service_backends": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/backends" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "certificate": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of Client Certificate Thumbprint." - }, - "query": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Query Parameter description." - }, - "header": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Header Parameter description." - }, - "url": { - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings." - }, - "username": { - "type": "string", - "description": "Username to connect to the WebProxy server" - }, - "password": { - "type": "string", - "description": "Password to connect to the WebProxy Server" - }, - "title": { - "type": "string", - "minLength": 1, - "maxLength": 300, - "description": "Backend Title." - }, - "description": { - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Backend Description." - }, - "resourceId": { - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "http", - "soap" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend communication protocol." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "url", - "properties", - "protocol" - ], - "description": "Microsoft.ApiManagement/service/backends" - }, - "service_certificates": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "data": { - "type": "string", - "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." - }, - "password": { - "type": "string", - "description": "Password for the Certificate" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "data", - "password" - ], - "description": "Microsoft.ApiManagement/service/certificates" - }, - "service_groups": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Group identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/groups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "Group description." - }, - "externalId": { - "type": "string", - "description": "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." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_groups_users_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/groups" - }, - "service_groups_users": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/groups/users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/groups/users" - }, - "service_identityProviders": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "facebook", - "google", - "microsoft", - "twitter", - "aad", - "aadB2C" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identity Provider Type identifier." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/identityProviders" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "clientId": { - "type": "string", - "minLength": 1, - "description": "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": { - "type": "string", - "minLength": 1, - "description": "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." - }, - "allowedTenants": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of Allowed Tenants when configuring Azure Active Directory login." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "clientId", - "clientSecret" - ], - "description": "Microsoft.ApiManagement/service/identityProviders" - }, - "service_loggers": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Logger identifier. Must be unique in the API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/loggers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "Logger description." - }, - "credentials": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name and SendRule connection string of the event hub." - }, - "isBuffered": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "credentials" - ], - "description": "Microsoft.ApiManagement/service/loggers" - }, - "service_openidConnectProviders": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the OpenID Connect Provider." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/openidConnectProviders" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "User-friendly description of OpenID Connect Provider." - }, - "metadataEndpoint": { - "type": "string", - "description": "Metadata endpoint URI." - }, - "clientId": { - "type": "string", - "description": "Client ID of developer console which is the client application." - }, - "clientSecret": { - "type": "string", - "description": "Client Secret of developer console which is the client application." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "metadataEndpoint", - "clientId" - ], - "description": "Microsoft.ApiManagement/service/openidConnectProviders" - }, - "service_products": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Product identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/products" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "minLength": 1, - "maxLength": 1000, - "description": "Product description. May include HTML formatting tags." - }, - "terms": { - "type": "string", - "description": "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." - }, - "subscriptionRequired": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true." - }, - "approvalRequired": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "subscriptionsLimit": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotPublished", - "Published" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_products_apis_childResource" - }, - { - "$ref": "#/definitions/service_products_groups_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products" - }, - "service_products_apis": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "API identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/products/apis" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products/apis" - }, - "service_products_groups": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Group identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/products/groups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products/groups" - }, - "service_properties": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the property." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/properties" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 4096, - "description": "Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace." - }, - "tags": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Optional tags that when provided can be used to filter the property list." - }, - "secret": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Determines whether the value is a secret and should be encrypted or not. Default value is false." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "value" - ], - "description": "Microsoft.ApiManagement/service/properties" - }, - "service_subscriptions": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/subscriptions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "userId": { - "type": "string", - "description": "User (user id path) for whom subscription is being created in form /users/{uid}" - }, - "productId": { - "type": "string", - "description": "Product (product id path) for which subscription is being created in form /products/{productid}" - }, - "primaryKey": { - "type": "string", - "minLength": 1, - "maxLength": 256, - "description": "Primary subscription key. If not specified during request key will be generated automatically." - }, - "secondaryKey": { - "type": "string", - "minLength": 1, - "maxLength": 256, - "description": "Secondary subscription key. If not specified during request key will be generated automatically." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Suspended", - "Active", - "Expired", - "Submitted", - "Rejected", - "Cancelled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "userId", - "productId" - ], - "description": "Microsoft.ApiManagement/service/subscriptions" - }, - "service_users": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "email": { - "type": "string", - "minLength": 1, - "maxLength": 254, - "description": "Email address. Must not be empty and must be unique within the service instance." - }, - "password": { - "type": "string", - "description": "User Password." - }, - "firstName": { - "type": "string", - "minLength": 1, - "maxLength": 100, - "description": "First name." - }, - "lastName": { - "type": "string", - "minLength": 1, - "maxLength": 100, - "description": "Last name." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Active", - "Blocked" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "note": { - "type": "string", - "description": "Optional note about a user set by the administrator." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "email", - "password", - "firstName", - "lastName" - ], - "description": "Microsoft.ApiManagement/service/users" - } - }, - "definitions": { - "AdditionalRegion": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The location name of the additional region among Azure Data center regions." - }, - "skuType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Developer", - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU type in the location." - }, - "skuUnitCount": { - "oneOf": [ - { - "type": "integer", - "maximum": 10, - "default": "1" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "vpnconfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network configuration for the location." - } - }, - "required": [ - "location", - "skuType" - ], - "description": "Description of an additional API Management resource location." - }, - "ApiManagementServiceProperties": { - "type": "object", - "properties": { - "publisherEmail": { - "type": "string", - "maxLength": 100, - "description": "Publisher email." - }, - "publisherName": { - "type": "string", - "description": "Publisher name." - }, - "addresserEmail": { - "type": "string", - "description": "Addresser email." - }, - "hostnameConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/HostnameConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Custom hostname configuration of the API Management service." - }, - "vpnconfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network configuration of the API Management service." - }, - "additionalLocations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalRegion" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Additional datacenter locations of the API Management service." - }, - "customProperties": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Custom properties of the API Management service, like disabling TLS 1.0." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "External", - "Internal" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of VPN in which API Managemet 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." - } - }, - "required": [ - "publisherEmail", - "publisherName" - ], - "description": "Properties of an API Management service resource description." - }, - "ApiManagementServiceSkuProperties": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Developer", - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of the Sku." - }, - "capacity": { - "oneOf": [ - { - "type": "integer", - "default": "1" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity of the SKU (number of deployed units of the SKU). The default value is 1." - } - }, - "required": [ - "name" - ], - "description": "API Management service resource SKU properties." - }, - "AuthenticationSettingsContract": { - "type": "object", - "properties": { - "oAuth2": { - "oneOf": [ - { - "$ref": "#/definitions/OAuth2AuthenticationSettingsContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "API Authentication Settings." - }, - "BackendProperties": { - "type": "object", - "properties": { - "skipCertificateChainValidation": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host." - }, - "skipCertificateNameValidation": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host." - } - }, - "description": "Properties specific to a Backend." - }, - "CertificateInformation": { - "type": "object", - "properties": { - "expiry": { - "type": "string", - "format": "date-time", - "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." - }, - "thumbprint": { - "type": "string", - "description": "Thumbprint of the certificate." - }, - "subject": { - "type": "string", - "description": "Subject of the certificate." - } - }, - "required": [ - "expiry", - "thumbprint", - "subject" - ], - "description": "SSL certificate information." - }, - "HostnameConfiguration": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Proxy", - "Portal", - "Management", - "Scm" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Hostname type." - }, - "hostname": { - "type": "string", - "description": "Hostname." - }, - "certificate": { - "oneOf": [ - { - "$ref": "#/definitions/CertificateInformation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Certificate information." - } - }, - "required": [ - "type", - "hostname", - "certificate" - ], - "description": "Custom hostname configuration." - }, - "OAuth2AuthenticationSettingsContract": { - "type": "object", - "properties": { - "authorizationServerId": { - "type": "string", - "description": "OAuth authorization server identifier." - }, - "scope": { - "type": "string", - "description": "operations scope." - } - }, - "description": "API OAuth2 Authentication settings details." - }, - "ParameterContract": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Parameter name." - }, - "description": { - "type": "string", - "description": "Parameter description." - }, - "type": { - "type": "string", - "description": "Parameter type." - }, - "defaultValue": { - "type": "string", - "description": "Default parameter value." - }, - "required": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "whether parameter is required or not." - }, - "values": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Parameter values." - } - }, - "required": [ - "name", - "type" - ], - "description": "Operation parameters details." - }, - "RepresentationContract": { - "type": "object", - "properties": { - "contentType": { - "type": "string", - "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." - }, - "sample": { - "type": "string", - "description": "An example of the representation." - } - }, - "required": [ - "contentType" - ], - "description": "Operation request/response representation details." - }, - "RequestContract": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Operation request description." - }, - "queryParameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of operation request query parameters." - }, - "headers": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of operation request headers." - }, - "representations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RepresentationContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of operation request representations." - } - }, - "description": "Operation request details." - }, - "ResultContract": { - "type": "object", - "properties": { - "statusCode": { - "oneOf": [ - { - "type": "integer", - "minimum": 100, - "maximum": 599 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Operation response HTTP status code." - }, - "description": { - "type": "string", - "description": "Operation response description." - }, - "representations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RepresentationContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of operation response representations." - } - }, - "required": [ - "statusCode" - ], - "description": "Operation response details." - }, - "service_apis_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "API identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "apis" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "Description of the API. May include HTML formatting tags." - }, - "authenticationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AuthenticationSettingsContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of authentication settings included into this API." - }, - "subscriptionKeyParameterNames": { - "oneOf": [ - { - "$ref": "#/definitions/SubscriptionKeyParameterNamesContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocols over which API is made available." - }, - "serviceUrl": { - "type": "string", - "description": "Absolute URL of the backend service implementing this API." - }, - "path": { - "type": "string", - "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API." - }, - "protocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Http", - "Https" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Describes on which protocols the operations in this API can be invoked." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "serviceUrl", - "path", - "protocols" - ], - "description": "Microsoft.ApiManagement/service/apis" - }, - "service_apis_operations_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Operation identifier within an API. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "operations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "templateParameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of URL template parameters." - }, - "description": { - "type": "string", - "description": "Description of the operation. May include HTML formatting tags." - }, - "request": { - "oneOf": [ - { - "$ref": "#/definitions/RequestContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An entity containing request details." - }, - "responses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResultContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of Operation responses." - }, - "method": { - "type": "string", - "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them." - }, - "urlTemplate": { - "type": "string", - "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "method", - "urlTemplate" - ], - "description": "Microsoft.ApiManagement/service/apis/operations" - }, - "service_authorizationServers_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the authorization server." - }, - "type": { - "type": "string", - "enum": [ - "authorizationServers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "Description of the authorization server. Can contain HTML formatting tags." - }, - "clientRegistrationEndpoint": { - "type": "string", - "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." - }, - "authorizationEndpoint": { - "type": "string", - "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." - }, - "authorizationMethods": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "HEAD", - "OPTIONS", - "TRACE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional." - }, - "clientAuthenticationMethod": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Basic", - "Body" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format." - }, - "tokenBodyParameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/TokenBodyParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "OAuth token endpoint. Contains absolute URI to entity being referenced." - }, - "supportState": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security." - }, - "defaultScope": { - "type": "string", - "description": "Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values." - }, - "grantTypes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationCode", - "implicit", - "resourceOwnerPassword", - "clientCredentials" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Form of an authorization grant, which the client uses to request the access token." - }, - "bearerTokenSendingMethods": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationHeader", - "query" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the mechanism by which access token is passed to the API. " - }, - "clientId": { - "type": "string", - "description": "Client or app id registered with this authorization server." - }, - "clientSecret": { - "type": "string", - "description": "Client or app secret registered with this authorization server." - }, - "resourceOwnerUsername": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." - }, - "resourceOwnerPassword": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "clientRegistrationEndpoint", - "authorizationEndpoint", - "grantTypes", - "clientId" - ], - "description": "Microsoft.ApiManagement/service/authorizationServers" - }, - "service_backends_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "backends" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "certificate": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of Client Certificate Thumbprint." - }, - "query": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Query Parameter description." - }, - "header": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Header Parameter description." - }, - "url": { - "type": "string", - "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings." - }, - "username": { - "type": "string", - "description": "Username to connect to the WebProxy server" - }, - "password": { - "type": "string", - "description": "Password to connect to the WebProxy Server" - }, - "title": { - "type": "string", - "description": "Backend Title." - }, - "description": { - "type": "string", - "description": "Backend Description." - }, - "resourceId": { - "type": "string", - "description": "Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "http", - "soap" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend communication protocol." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "url", - "properties", - "protocol" - ], - "description": "Microsoft.ApiManagement/service/backends" - }, - "service_certificates_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "data": { - "type": "string", - "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." - }, - "password": { - "type": "string", - "description": "Password for the Certificate" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "data", - "password" - ], - "description": "Microsoft.ApiManagement/service/certificates" - }, - "service_groups_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Group identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "groups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "Group description." - }, - "externalId": { - "type": "string", - "description": "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." - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/groups" - }, - "service_groups_users_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/groups/users" - }, - "service_identityProviders_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "facebook", - "google", - "microsoft", - "twitter", - "aad", - "aadB2C" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identity Provider Type identifier." - }, - "type": { - "type": "string", - "enum": [ - "identityProviders" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "clientId": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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." - }, - "allowedTenants": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of Allowed Tenants when configuring Azure Active Directory login." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "clientId", - "clientSecret" - ], - "description": "Microsoft.ApiManagement/service/identityProviders" - }, - "service_loggers_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Logger identifier. Must be unique in the API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "loggers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "Logger description." - }, - "credentials": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name and SendRule connection string of the event hub." - }, - "isBuffered": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "credentials" - ], - "description": "Microsoft.ApiManagement/service/loggers" - }, - "service_openidConnectProviders_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the OpenID Connect Provider." - }, - "type": { - "type": "string", - "enum": [ - "openidConnectProviders" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "User-friendly description of OpenID Connect Provider." - }, - "metadataEndpoint": { - "type": "string", - "description": "Metadata endpoint URI." - }, - "clientId": { - "type": "string", - "description": "Client ID of developer console which is the client application." - }, - "clientSecret": { - "type": "string", - "description": "Client Secret of developer console which is the client application." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "metadataEndpoint", - "clientId" - ], - "description": "Microsoft.ApiManagement/service/openidConnectProviders" - }, - "service_products_apis_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "API identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "apis" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products/apis" - }, - "service_products_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Product identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "products" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "description": { - "type": "string", - "description": "Product description. May include HTML formatting tags." - }, - "terms": { - "type": "string", - "description": "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." - }, - "subscriptionRequired": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true." - }, - "approvalRequired": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "subscriptionsLimit": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotPublished", - "Published" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished." - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products" - }, - "service_products_groups_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Group identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "groups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products/groups" - }, - "service_properties_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the property." - }, - "type": { - "type": "string", - "enum": [ - "properties" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "value": { - "type": "string", - "description": "Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace." - }, - "tags": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Optional tags that when provided can be used to filter the property list." - }, - "secret": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Determines whether the value is a secret and should be encrypted or not. Default value is false." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "value" - ], - "description": "Microsoft.ApiManagement/service/properties" - }, - "service_subscriptions_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management." - }, - "type": { - "type": "string", - "enum": [ - "subscriptions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "userId": { - "type": "string", - "description": "User (user id path) for whom subscription is being created in form /users/{uid}" - }, - "productId": { - "type": "string", - "description": "Product (product id path) for which subscription is being created in form /products/{productid}" - }, - "primaryKey": { - "type": "string", - "description": "Primary subscription key. If not specified during request key will be generated automatically." - }, - "secondaryKey": { - "type": "string", - "description": "Secondary subscription key. If not specified during request key will be generated automatically." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Suspended", - "Active", - "Expired", - "Submitted", - "Rejected", - "Cancelled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "userId", - "productId" - ], - "description": "Microsoft.ApiManagement/service/subscriptions" - }, - "service_users_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-10-10" - ] - }, - "email": { - "type": "string", - "description": "Email address. Must not be empty and must be unique within the service instance." - }, - "password": { - "type": "string", - "description": "User Password." - }, - "firstName": { - "type": "string", - "description": "First name." - }, - "lastName": { - "type": "string", - "description": "Last name." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Active", - "Blocked" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "note": { - "type": "string", - "description": "Optional note about a user set by the administrator." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "email", - "password", - "firstName", - "lastName" - ], - "description": "Microsoft.ApiManagement/service/users" - }, - "SubscriptionKeyParameterNamesContract": { - "type": "object", - "properties": { - "header": { - "type": "string", - "description": "Subscription key header name." - }, - "query": { - "type": "string", - "description": "Subscription key query string parameter name." - } - }, - "description": "Subscription key parameter names details." - }, - "TokenBodyParameterContract": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "body parameter name." - }, - "value": { - "type": "string", - "description": "body parameter value." - } - }, - "required": [ - "name", - "value" - ], - "description": "OAuth acquire token request body parameter (www-url-form-encoded)." - }, - "VirtualNetworkConfiguration": { - "type": "object", - "properties": { - "subnetResourceId": { - "oneOf": [ - { - "type": "string", - "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." - }, - "location": { - "type": "string", - "description": "The location of the virtual network." - } - }, - "description": "Configuration of a virtual network to which API Management service is deployed." - } - } -} diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service.md b/test/Resource/Expected/ApiManagement/2016-10-10/service.md deleted file mode 100644 index 3a7ff49..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service.md +++ /dev/null @@ -1,128 +0,0 @@ -# Microsoft.ApiManagement/service template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service", - "apiVersion": "2016-10-10", - "location": "string", - "tags": {}, - "properties": { - "publisherEmail": "string", - "publisherName": "string", - "addresserEmail": "string", - "hostnameConfigurations": [ - { - "type": "string", - "hostname": "string", - "certificate": { - "expiry": "string", - "thumbprint": "string", - "subject": "string" - } - } - ], - "vpnconfiguration": { - "subnetResourceId": "string", - "location": "string" - }, - "additionalLocations": [ - { - "location": "string", - "skuType": "string", - "skuUnitCount": "integer", - "vpnconfiguration": { - "subnetResourceId": "string", - "location": "string" - } - } - ], - "customProperties": {}, - "vpnType": "string" - }, - "sku": { - "name": "string", - "capacity": "integer" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the API Management service. | -| type | enum | Yes | Microsoft.ApiManagement/service | -| apiVersion | enum | Yes | 2016-10-10 | -| location | string | Yes | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the API Management service. - [ApiManagementServiceProperties object](#ApiManagementServiceProperties) | -| sku | object | Yes | SKU properties of the API Management service. - [ApiManagementServiceSkuProperties object](#ApiManagementServiceSkuProperties) | -| resources | array | No | [users](./service/users.md) [subscriptions](./service/subscriptions.md) [properties](./service/properties.md) [products](./service/products.md) [openidConnectProviders](./service/openidConnectProviders.md) [loggers](./service/loggers.md) [identityProviders](./service/identityProviders.md) [groups](./service/groups.md) [certificates](./service/certificates.md) [backends](./service/backends.md) [authorizationServers](./service/authorizationServers.md) [apis](./service/apis.md) | - - - -### ApiManagementServiceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publisherEmail | string | Yes | Publisher email. | -| publisherName | string | Yes | Publisher name. | -| addresserEmail | string | No | Addresser email. | -| hostnameConfigurations | array | No | Custom hostname configuration of the API Management service. - [HostnameConfiguration object](#HostnameConfiguration) | -| vpnconfiguration | object | No | Virtual network configuration of the API Management service. - [VirtualNetworkConfiguration object](#VirtualNetworkConfiguration) | -| additionalLocations | array | No | Additional datacenter locations of the API Management service. - [AdditionalRegion object](#AdditionalRegion) | -| customProperties | object | No | Custom properties of the API Management service, like disabling TLS 1.0. | -| vpnType | enum | No | The type of VPN in which API Managemet 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. - None, External, Internal | - - - -### ApiManagementServiceSkuProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Name of the Sku. - Developer, Standard, Premium | -| capacity | integer | No | Capacity of the SKU (number of deployed units of the SKU). The default value is 1. | - - - -### HostnameConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | Yes | Hostname type. - Proxy, Portal, Management, Scm | -| hostname | string | Yes | Hostname. | -| certificate | object | Yes | Certificate information. - [CertificateInformation object](#CertificateInformation) | - - - -### VirtualNetworkConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnetResourceId | string | No | The full resource ID of a subnet in a virtual network to deploy the API Management service in. | -| location | string | No | The location of the virtual network. | - - - -### AdditionalRegion object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| location | string | Yes | The location name of the additional region among Azure Data center regions. | -| skuType | enum | Yes | The SKU type in the location. - Developer, Standard, Premium | -| skuUnitCount | integer | No | 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. | -| vpnconfiguration | object | No | Virtual network configuration for the location. - [VirtualNetworkConfiguration object](#VirtualNetworkConfiguration) | - - - -### CertificateInformation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| expiry | string | Yes | Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. | -| thumbprint | string | Yes | Thumbprint of the certificate. | -| subject | string | Yes | Subject of the certificate. | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/apis.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/apis.md deleted file mode 100644 index 85fc59f..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/apis.md +++ /dev/null @@ -1,72 +0,0 @@ -# Microsoft.ApiManagement/service/apis template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/apis resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/apis", - "apiVersion": "2016-10-10", - "description": "string", - "authenticationSettings": { - "oAuth2": { - "authorizationServerId": "string", - "scope": "string" - } - }, - "subscriptionKeyParameterNames": { - "header": "string", - "query": "string" - }, - "serviceUrl": "string", - "path": "string", - "protocols": [ - "string" - ], - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/apis object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | API identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/apis | -| apiVersion | enum | Yes | 2016-10-10 | -| description | string | No | Description of the API. May include HTML formatting tags. | -| authenticationSettings | object | No | Collection of authentication settings included into this API. - [AuthenticationSettingsContract object](#AuthenticationSettingsContract) | -| subscriptionKeyParameterNames | object | No | Protocols over which API is made available. - [SubscriptionKeyParameterNamesContract object](#SubscriptionKeyParameterNamesContract) | -| serviceUrl | string | Yes | Absolute URL of the backend service implementing this API. | -| path | string | Yes | Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. | -| protocols | array | Yes | Describes on which protocols the operations in this API can be invoked. - Http or Https | -| resources | array | No | [operations](./apis/operations.md) | - - - -### AuthenticationSettingsContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| oAuth2 | object | No | [OAuth2AuthenticationSettingsContract object](#OAuth2AuthenticationSettingsContract) | - - - -### SubscriptionKeyParameterNamesContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| header | string | No | Subscription key header name. | -| query | string | No | Subscription key query string parameter name. | - - - -### OAuth2AuthenticationSettingsContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationServerId | string | No | OAuth authorization server identifier. | -| scope | string | No | operations scope. | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/apis/operations.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/apis/operations.md deleted file mode 100644 index 86b0adc..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/apis/operations.md +++ /dev/null @@ -1,130 +0,0 @@ -# Microsoft.ApiManagement/service/apis/operations template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/apis/operations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/apis/operations", - "apiVersion": "2016-10-10", - "templateParameters": [ - { - "name": "string", - "description": "string", - "type": "string", - "defaultValue": "string", - "required": "boolean", - "values": [ - "string" - ] - } - ], - "description": "string", - "request": { - "description": "string", - "queryParameters": [ - { - "name": "string", - "description": "string", - "type": "string", - "defaultValue": "string", - "required": "boolean", - "values": [ - "string" - ] - } - ], - "headers": [ - { - "name": "string", - "description": "string", - "type": "string", - "defaultValue": "string", - "required": "boolean", - "values": [ - "string" - ] - } - ], - "representations": [ - { - "contentType": "string", - "sample": "string" - } - ] - }, - "responses": [ - { - "statusCode": "integer", - "description": "string", - "representations": [ - { - "contentType": "string", - "sample": "string" - } - ] - } - ], - "method": "string", - "urlTemplate": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/apis/operations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Operation identifier within an API. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/apis/operations | -| apiVersion | enum | Yes | 2016-10-10 | -| templateParameters | array | No | Collection of URL template parameters. - [ParameterContract object](#ParameterContract) | -| description | string | No | Description of the operation. May include HTML formatting tags. | -| request | object | No | An entity containing request details. - [RequestContract object](#RequestContract) | -| responses | array | No | Array of Operation responses. - [ResultContract object](#ResultContract) | -| method | string | Yes | A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. | -| urlTemplate | string | Yes | Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} | - - - -### ParameterContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Parameter name. | -| description | string | No | Parameter description. | -| type | string | Yes | Parameter type. | -| defaultValue | string | No | Default parameter value. | -| required | boolean | No | whether parameter is required or not. | -| values | array | No | Parameter values. - string | - - - -### RequestContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Operation request description. | -| queryParameters | array | No | Collection of operation request query parameters. - [ParameterContract object](#ParameterContract) | -| headers | array | No | Collection of operation request headers. - [ParameterContract object](#ParameterContract) | -| representations | array | No | Collection of operation request representations. - [RepresentationContract object](#RepresentationContract) | - - - -### ResultContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| statusCode | integer | Yes | Operation response HTTP status code. | -| description | string | No | Operation response description. | -| representations | array | No | Collection of operation response representations. - [RepresentationContract object](#RepresentationContract) | - - - -### RepresentationContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| contentType | string | Yes | Specifies a registered or custom content type for this representation, e.g. application/xml. | -| sample | string | No | An example of the representation. | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/authorizationServers.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/authorizationServers.md deleted file mode 100644 index 770908b..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/authorizationServers.md +++ /dev/null @@ -1,76 +0,0 @@ -# Microsoft.ApiManagement/service/authorizationServers template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/authorizationServers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/authorizationServers", - "apiVersion": "2016-10-10", - "description": "string", - "clientRegistrationEndpoint": "string", - "authorizationEndpoint": "string", - "authorizationMethods": [ - "string" - ], - "clientAuthenticationMethod": [ - "string" - ], - "tokenBodyParameters": [ - { - "name": "string", - "value": "string" - } - ], - "tokenEndpoint": "string", - "supportState": "boolean", - "defaultScope": "string", - "grantTypes": [ - "string" - ], - "bearerTokenSendingMethods": [ - "string" - ], - "clientId": "string", - "clientSecret": "string", - "resourceOwnerUsername": "string", - "resourceOwnerPassword": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/authorizationServers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the authorization server. | -| type | enum | Yes | Microsoft.ApiManagement/service/authorizationServers | -| apiVersion | enum | Yes | 2016-10-10 | -| description | string | No | Description of the authorization server. Can contain HTML formatting tags. | -| clientRegistrationEndpoint | string | Yes | Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. | -| authorizationEndpoint | string | Yes | OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. | -| authorizationMethods | array | No | HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. - HEAD, OPTIONS, TRACE, GET, POST, PUT, PATCH, DELETE | -| clientAuthenticationMethod | array | No | Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. - Basic or Body | -| tokenBodyParameters | array | No | 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"}. - [TokenBodyParameterContract object](#TokenBodyParameterContract) | -| tokenEndpoint | string | No | OAuth token endpoint. Contains absolute URI to entity being referenced. | -| supportState | boolean | No | If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. | -| defaultScope | string | No | Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. | -| grantTypes | array | Yes | Form of an authorization grant, which the client uses to request the access token. - authorizationCode, implicit, resourceOwnerPassword, clientCredentials | -| bearerTokenSendingMethods | array | No | Specifies the mechanism by which access token is passed to the API. - authorizationHeader or query | -| clientId | string | Yes | Client or app id registered with this authorization server. | -| clientSecret | string | No | Client or app secret registered with this authorization server. | -| resourceOwnerUsername | string | No | Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. | -| resourceOwnerPassword | string | No | Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. | - - - -### TokenBodyParameterContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | body parameter name. | -| value | string | Yes | body parameter value. | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/backends.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/backends.md deleted file mode 100644 index 5952717..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/backends.md +++ /dev/null @@ -1,60 +0,0 @@ -# Microsoft.ApiManagement/service/backends template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/backends resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/backends", - "apiVersion": "2016-10-10", - "certificate": [ - "string" - ], - "query": {}, - "header": {}, - "url": "string", - "username": "string", - "password": "string", - "title": "string", - "description": "string", - "resourceId": "string", - "properties": { - "skipCertificateChainValidation": "boolean", - "skipCertificateNameValidation": "boolean" - }, - "protocol": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/backends object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the Backend entity. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/backends | -| apiVersion | enum | Yes | 2016-10-10 | -| certificate | array | No | List of Client Certificate Thumbprint. - string | -| query | object | No | Query Parameter description. | -| header | object | No | Header Parameter description. | -| url | string | Yes | WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. | -| username | string | No | Username to connect to the WebProxy server | -| password | string | No | Password to connect to the WebProxy Server | -| title | string | No | Backend Title. | -| description | string | No | Backend Description. | -| resourceId | string | No | Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. | -| properties | object | Yes | [BackendProperties object](#BackendProperties) | -| protocol | enum | Yes | Backend communication protocol. - http or soap | - - - -### BackendProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| skipCertificateChainValidation | boolean | No | Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. | -| skipCertificateNameValidation | boolean | No | Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host. | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/certificates.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/certificates.md deleted file mode 100644 index 269408b..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/certificates.md +++ /dev/null @@ -1,29 +0,0 @@ -# Microsoft.ApiManagement/service/certificates template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/certificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/certificates", - "apiVersion": "2016-10-10", - "data": "string", - "password": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/certificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the certificate entity. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/certificates | -| apiVersion | enum | Yes | 2016-10-10 | -| data | string | Yes | Base 64 encoded certificate using the application/x-pkcs12 representation. | -| password | string | Yes | Password for the Certificate | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/groups.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/groups.md deleted file mode 100644 index 6542eb2..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/groups.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.ApiManagement/service/groups template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/groups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/groups", - "apiVersion": "2016-10-10", - "description": "string", - "externalId": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/groups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/groups | -| apiVersion | enum | Yes | 2016-10-10 | -| description | string | No | Group description. | -| externalId | string | No | 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. | -| resources | array | No | [users](./groups/users.md) | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/groups/users.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/groups/users.md deleted file mode 100644 index 03c88a8..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/groups/users.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.ApiManagement/service/groups/users template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/groups/users resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/groups/users", - "apiVersion": "2016-10-10" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/groups/users object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | User identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/groups/users | -| apiVersion | enum | Yes | 2016-10-10 | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/identityProviders.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/identityProviders.md deleted file mode 100644 index 262ef04..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/identityProviders.md +++ /dev/null @@ -1,33 +0,0 @@ -# Microsoft.ApiManagement/service/identityProviders template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/identityProviders resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/identityProviders", - "apiVersion": "2016-10-10", - "clientId": "string", - "clientSecret": "string", - "allowedTenants": [ - "string" - ] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/identityProviders object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Identity Provider Type identifier. - facebook, google, microsoft, twitter, aad, aadB2C | -| type | enum | Yes | Microsoft.ApiManagement/service/identityProviders | -| apiVersion | enum | Yes | 2016-10-10 | -| clientId | string | Yes | 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 | Yes | 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. | -| allowedTenants | array | No | List of Allowed Tenants when configuring Azure Active Directory login. - string | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/loggers.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/loggers.md deleted file mode 100644 index f803bb7..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/loggers.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.ApiManagement/service/loggers template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/loggers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/loggers", - "apiVersion": "2016-10-10", - "description": "string", - "credentials": {}, - "isBuffered": "boolean" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/loggers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Logger identifier. Must be unique in the API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/loggers | -| apiVersion | enum | Yes | 2016-10-10 | -| description | string | No | Logger description. | -| credentials | object | Yes | The name and SendRule connection string of the event hub. | -| isBuffered | boolean | No | Whether records are buffered in the logger before publishing. Default is assumed to be true. | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/openidConnectProviders.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/openidConnectProviders.md deleted file mode 100644 index b90bf57..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/openidConnectProviders.md +++ /dev/null @@ -1,33 +0,0 @@ -# Microsoft.ApiManagement/service/openidConnectProviders template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/openidConnectProviders resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/openidConnectProviders", - "apiVersion": "2016-10-10", - "description": "string", - "metadataEndpoint": "string", - "clientId": "string", - "clientSecret": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/openidConnectProviders object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the OpenID Connect Provider. | -| type | enum | Yes | Microsoft.ApiManagement/service/openidConnectProviders | -| apiVersion | enum | Yes | 2016-10-10 | -| description | string | No | User-friendly description of OpenID Connect Provider. | -| metadataEndpoint | string | Yes | Metadata endpoint URI. | -| clientId | string | Yes | Client ID of developer console which is the client application. | -| clientSecret | string | No | Client Secret of developer console which is the client application. | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/products.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/products.md deleted file mode 100644 index 36fb045..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/products.md +++ /dev/null @@ -1,39 +0,0 @@ -# Microsoft.ApiManagement/service/products template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/products resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/products", - "apiVersion": "2016-10-10", - "description": "string", - "terms": "string", - "subscriptionRequired": "boolean", - "approvalRequired": "boolean", - "subscriptionsLimit": "integer", - "state": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/products object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Product identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/products | -| apiVersion | enum | Yes | 2016-10-10 | -| description | string | No | Product description. May include HTML formatting tags. | -| terms | string | No | 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. | -| subscriptionRequired | boolean | No | Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. | -| approvalRequired | boolean | No | 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. | -| subscriptionsLimit | integer | No | 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. | -| state | enum | No | whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. - NotPublished or Published | -| resources | array | No | [groups](./products/groups.md) [apis](./products/apis.md) | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/products/apis.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/products/apis.md deleted file mode 100644 index 938d9f3..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/products/apis.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.ApiManagement/service/products/apis template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/products/apis resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/products/apis", - "apiVersion": "2016-10-10" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/products/apis object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | API identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/products/apis | -| apiVersion | enum | Yes | 2016-10-10 | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/products/groups.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/products/groups.md deleted file mode 100644 index c2a0663..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/products/groups.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.ApiManagement/service/products/groups template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/products/groups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/products/groups", - "apiVersion": "2016-10-10" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/products/groups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/products/groups | -| apiVersion | enum | Yes | 2016-10-10 | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/properties.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/properties.md deleted file mode 100644 index 8b5e37d..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/properties.md +++ /dev/null @@ -1,33 +0,0 @@ -# Microsoft.ApiManagement/service/properties template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/properties resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/properties", - "apiVersion": "2016-10-10", - "value": "string", - "tags": [ - "string" - ], - "secret": "boolean" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/properties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the property. | -| type | enum | Yes | Microsoft.ApiManagement/service/properties | -| apiVersion | enum | Yes | 2016-10-10 | -| value | string | Yes | Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. | -| tags | array | No | Optional tags that when provided can be used to filter the property list. - string | -| secret | boolean | No | Determines whether the value is a secret and should be encrypted or not. Default value is false. | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/subscriptions.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/subscriptions.md deleted file mode 100644 index 529511b..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/subscriptions.md +++ /dev/null @@ -1,35 +0,0 @@ -# Microsoft.ApiManagement/service/subscriptions template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/subscriptions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/subscriptions", - "apiVersion": "2016-10-10", - "userId": "string", - "productId": "string", - "primaryKey": "string", - "secondaryKey": "string", - "state": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/subscriptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Subscription entity Identifier. The entity represents the association between a user and a product in API Management. | -| type | enum | Yes | Microsoft.ApiManagement/service/subscriptions | -| apiVersion | enum | Yes | 2016-10-10 | -| userId | string | Yes | User (user id path) for whom subscription is being created in form /users/{uid} | -| productId | string | Yes | Product (product id path) for which subscription is being created in form /products/{productid} | -| primaryKey | string | No | Primary subscription key. If not specified during request key will be generated automatically. | -| secondaryKey | string | No | Secondary subscription key. If not specified during request key will be generated automatically. | -| state | enum | No | Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. - Suspended, Active, Expired, Submitted, Rejected, Cancelled | - diff --git a/test/Resource/Expected/ApiManagement/2016-10-10/service/users.md b/test/Resource/Expected/ApiManagement/2016-10-10/service/users.md deleted file mode 100644 index d1c44ea..0000000 --- a/test/Resource/Expected/ApiManagement/2016-10-10/service/users.md +++ /dev/null @@ -1,37 +0,0 @@ -# Microsoft.ApiManagement/service/users template reference -API Version: 2016-10-10 -## Template format - -To create a Microsoft.ApiManagement/service/users resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/users", - "apiVersion": "2016-10-10", - "email": "string", - "password": "string", - "firstName": "string", - "lastName": "string", - "state": "string", - "note": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/users object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | User identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/users | -| apiVersion | enum | Yes | 2016-10-10 | -| email | string | Yes | Email address. Must not be empty and must be unique within the service instance. | -| password | string | Yes | User Password. | -| firstName | string | Yes | First name. | -| lastName | string | Yes | Last name. | -| state | enum | No | 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. - Active or Blocked | -| note | string | No | Optional note about a user set by the administrator. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/Microsoft.ApiManagement.json b/test/Resource/Expected/ApiManagement/2017-03-01/Microsoft.ApiManagement.json deleted file mode 100644 index de20ab2..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/Microsoft.ApiManagement.json +++ /dev/null @@ -1,4383 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-03-01/Microsoft.ApiManagement.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.ApiManagement", - "description": "Microsoft ApiManagement Resource Types", - "resourceDefinitions": { - "service": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the API Management service." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApiManagementServiceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the API Management service." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApiManagementServiceSkuProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU properties of the API Management service." - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/ApiManagementServiceIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Managed service identity of the Api Management service." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_policies_childResource" - }, - { - "$ref": "#/definitions/service_apis_childResource" - }, - { - "$ref": "#/definitions/service_authorizationServers_childResource" - }, - { - "$ref": "#/definitions/service_backends_childResource" - }, - { - "$ref": "#/definitions/service_certificates_childResource" - }, - { - "$ref": "#/definitions/service_templates_childResource" - }, - { - "$ref": "#/definitions/service_groups_childResource" - }, - { - "$ref": "#/definitions/service_identityProviders_childResource" - }, - { - "$ref": "#/definitions/service_loggers_childResource" - }, - { - "$ref": "#/definitions/service_notifications_childResource" - }, - { - "$ref": "#/definitions/service_openidConnectProviders_childResource" - }, - { - "$ref": "#/definitions/service_products_childResource" - }, - { - "$ref": "#/definitions/service_properties_childResource" - }, - { - "$ref": "#/definitions/service_subscriptions_childResource" - }, - { - "$ref": "#/definitions/service_users_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties", - "sku", - "location" - ], - "description": "Microsoft.ApiManagement/service" - }, - "service_apis": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "API identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/apis" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApiCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Api entity create of update properties." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_apis_operations_childResource" - }, - { - "$ref": "#/definitions/service_apis_policies_childResource" - }, - { - "$ref": "#/definitions/service_apis_schemas_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis" - }, - "service_apis_operations": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Operation identifier within an API. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/apis/operations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OperationContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Operation Contract." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_apis_operations_policies_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis/operations" - }, - "service_apis_operations_policies": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "policy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier of the Policy." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/apis/operations/policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Policy." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis/operations/policies" - }, - "service_apis_policies": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "policy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier of the Policy." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/apis/policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Policy." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis/policies" - }, - "service_apis_schemas": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Schema identifier within an API. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/apis/schemas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SchemaContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Schema." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis/schemas" - }, - "service_authorizationServers": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the authorization server." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/authorizationServers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationServerContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the External OAuth authorization server Contract." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/authorizationServers" - }, - "service_backends": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/backends" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend entity contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/backends" - }, - "service_certificates": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CertificateCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Certificate create or update properties details." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/certificates" - }, - "service_groups": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Group identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/groups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/GroupCreateParametersProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties supplied to Create Group operation." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_groups_users_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/groups" - }, - "service_groups_users": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/groups/users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/groups/users" - }, - "service_identityProviders": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "facebook", - "google", - "microsoft", - "twitter", - "aad", - "aadB2C" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identity Provider Type identifier." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/identityProviders" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IdentityProviderContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identity Provider contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/identityProviders" - }, - "service_loggers": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Logger identifier. Must be unique in the API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/loggers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoggerContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Logger entity contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/loggers" - }, - "service_notifications": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "RequestPublisherNotificationMessage", - "PurchasePublisherNotificationMessage", - "NewApplicationNotificationMessage", - "BCC", - "NewIssuePublisherNotificationMessage", - "AccountClosedPublisher", - "QuotaLimitApproachingPublisherNotificationMessage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Notification Name Identifier." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/notifications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_notifications_recipientUsers_childResource" - }, - { - "$ref": "#/definitions/service_notifications_recipientEmails_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/notifications" - }, - "service_notifications_recipientEmails": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Email identifier." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/notifications/recipientEmails" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/notifications/recipientEmails" - }, - "service_notifications_recipientUsers": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/notifications/recipientUsers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/notifications/recipientUsers" - }, - "service_openidConnectProviders": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the OpenID Connect Provider." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/openidConnectProviders" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OpenidConnectProviderContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "OpenId Connect Provider contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/openidConnectProviders" - }, - "service_policies": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "policy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier of the Policy." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Policy." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/policies" - }, - "service_products": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Product identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/products" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProductContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Product entity contract properties." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/service_products_apis_childResource" - }, - { - "$ref": "#/definitions/service_products_groups_childResource" - }, - { - "$ref": "#/definitions/service_products_policies_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/products" - }, - "service_products_apis": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "API identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/products/apis" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products/apis" - }, - "service_products_groups": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Group identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/products/groups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products/groups" - }, - "service_products_policies": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "policy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier of the Policy." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/products/policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Policy." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/products/policies" - }, - "service_properties": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the property." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/properties" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PropertyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Property entity contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/properties" - }, - "service_subscriptions": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/subscriptions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubscriptionCreateParameterProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subscription contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/subscriptions" - }, - "service_templates": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "applicationApprovedNotificationMessage", - "accountClosedDeveloper", - "quotaLimitApproachingDeveloperNotificationMessage", - "newDeveloperNotificationMessage", - "emailChangeIdentityDefault", - "inviteUserNotificationMessage", - "newCommentNotificationMessage", - "confirmSignUpIdentityDefault", - "newIssueNotificationMessage", - "purchaseDeveloperNotificationMessage", - "passwordResetIdentityDefault", - "passwordResetByAdminNotificationMessage", - "rejectDeveloperNotificationMessage", - "requestDeveloperNotificationMessage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Email Template Name Identifier." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/templates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/EmailTemplateUpdateParameterProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Email Template Update contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/templates" - }, - "service_users": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ApiManagement/service/users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/UserCreateParameterProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User entity create contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/users" - } - }, - "definitions": { - "AdditionalLocation": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The location name of the additional region among Azure Data center regions." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApiManagementServiceSkuProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU properties of the API Management service." - }, - "virtualNetworkConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network configuration for the location." - } - }, - "required": [ - "location", - "sku" - ], - "description": "Description of an additional API Management resource location." - }, - "ApiCreateOrUpdateProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the API. May include HTML formatting tags." - }, - "authenticationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AuthenticationSettingsContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of authentication settings included into this API." - }, - "subscriptionKeyParameterNames": { - "oneOf": [ - { - "$ref": "#/definitions/SubscriptionKeyParameterNamesContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocols over which API is made available." - }, - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "http", - "soap" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of API." - }, - "apiRevision": { - "type": "string", - "minLength": 1, - "maxLength": 100, - "description": "Describes the Revision of the Api. If no value is provided, default revision 1 is created" - }, - "isCurrent": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if API revision is current api revision." - }, - "isOnline": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if API revision is accessible via the gateway." - }, - "displayName": { - "type": "string", - "minLength": 1, - "maxLength": 300, - "description": "API name." - }, - "serviceUrl": { - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Absolute URL of the backend service implementing this API." - }, - "path": { - "type": "string", - "minLength": 0, - "maxLength": 400, - "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API." - }, - "protocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "http", - "https" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Describes on which protocols the operations in this API can be invoked." - }, - "contentValue": { - "type": "string", - "description": "Content value when Importing an API." - }, - "contentFormat": { - "oneOf": [ - { - "type": "string", - "enum": [ - "wadl-xml", - "wadl-link-json", - "swagger-json", - "swagger-link-json", - "wsdl", - "wsdl-link" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Format of the Content in which the API is getting imported." - }, - "wsdlSelector": { - "oneOf": [ - { - "$ref": "#/definitions/ApiCreateOrUpdatePropertiesWsdlSelector" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Criteria to limit import of WSDL to a subset of the document." - } - }, - "required": [ - "path" - ], - "description": "Api Create or Update Properties." - }, - "ApiCreateOrUpdatePropertiesWsdlSelector": { - "type": "object", - "properties": { - "wsdlServiceName": { - "type": "string", - "description": "Name of service to import from WSDL" - }, - "wsdlEndpointName": { - "type": "string", - "description": "Name of endpoint(port) to import from WSDL" - } - }, - "description": "Criteria to limit import of WSDL to a subset of the document." - }, - "ApiManagementServiceIdentity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity type. Currently the only supported type is 'SystemAssigned'." - } - }, - "required": [ - "type" - ], - "description": "Identity properties of the Api Management service resource." - }, - "ApiManagementServiceProperties": { - "type": "object", - "properties": { - "notificationSenderEmail": { - "type": "string", - "maxLength": 100, - "description": "Email address from which the notification will be sent." - }, - "hostnameConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/HostnameConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Custom hostname configuration of the API Management service." - }, - "virtualNetworkConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network configuration of the API Management service." - }, - "additionalLocations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalLocation" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Additional datacenter locations of the API Management service." - }, - "customProperties": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "certificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/CertificateConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10." - }, - "virtualNetworkType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "External", - "Internal" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of VPN in which API Managemet 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." - }, - "publisherEmail": { - "type": "string", - "maxLength": 100, - "description": "Publisher email." - }, - "publisherName": { - "type": "string", - "maxLength": 100, - "description": "Publisher name." - } - }, - "required": [ - "publisherEmail", - "publisherName" - ], - "description": "Properties of an API Management service resource description." - }, - "ApiManagementServiceSkuProperties": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Developer", - "Standard", - "Premium", - "Basic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of the Sku." - }, - "capacity": { - "oneOf": [ - { - "type": "integer", - "default": "1" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity of the SKU (number of deployed units of the SKU). The default value is 1." - } - }, - "required": [ - "name" - ], - "description": "API Management service resource SKU properties." - }, - "AuthenticationSettingsContract": { - "type": "object", - "properties": { - "oAuth2": { - "oneOf": [ - { - "$ref": "#/definitions/OAuth2AuthenticationSettingsContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "OAuth2 Authentication settings" - } - }, - "description": "API Authentication Settings." - }, - "AuthorizationServerContractProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the authorization server. Can contain HTML formatting tags." - }, - "authorizationMethods": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "HEAD", - "OPTIONS", - "TRACE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional." - }, - "clientAuthenticationMethod": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Basic", - "Body" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format." - }, - "tokenBodyParameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/TokenBodyParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "OAuth token endpoint. Contains absolute URI to entity being referenced." - }, - "supportState": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security." - }, - "defaultScope": { - "type": "string", - "description": "Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values." - }, - "bearerTokenSendingMethods": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationHeader", - "query" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the mechanism by which access token is passed to the API. " - }, - "clientSecret": { - "type": "string", - "description": "Client or app secret registered with this authorization server." - }, - "resourceOwnerUsername": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." - }, - "resourceOwnerPassword": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." - }, - "displayName": { - "type": "string", - "minLength": 1, - "maxLength": 50, - "description": "User-friendly authorization server name." - }, - "clientRegistrationEndpoint": { - "type": "string", - "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." - }, - "authorizationEndpoint": { - "type": "string", - "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." - }, - "grantTypes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationCode", - "implicit", - "resourceOwnerPassword", - "clientCredentials" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Form of an authorization grant, which the client uses to request the access token." - }, - "clientId": { - "type": "string", - "description": "Client or app id registered with this authorization server." - } - }, - "required": [ - "displayName", - "clientRegistrationEndpoint", - "authorizationEndpoint", - "grantTypes", - "clientId" - ], - "description": "External OAuth authorization server settings Properties." - }, - "BackendAuthorizationHeaderCredentials": { - "type": "object", - "properties": { - "scheme": { - "type": "string", - "minLength": 1, - "maxLength": 100, - "description": "Authentication Scheme name." - }, - "parameter": { - "type": "string", - "minLength": 1, - "maxLength": 300, - "description": "Authentication Parameter value." - } - }, - "required": [ - "scheme", - "parameter" - ], - "description": "Authorization header information." - }, - "BackendContractProperties": { - "type": "object", - "properties": { - "title": { - "type": "string", - "minLength": 1, - "maxLength": 300, - "description": "Backend Title." - }, - "description": { - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Backend Description." - }, - "resourceId": { - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend Properties contract" - }, - "credentials": { - "oneOf": [ - { - "$ref": "#/definitions/BackendCredentialsContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend Credentials Contract Properties" - }, - "proxy": { - "oneOf": [ - { - "$ref": "#/definitions/BackendProxyContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend Proxy Contract Properties" - }, - "tls": { - "oneOf": [ - { - "$ref": "#/definitions/BackendTlsProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend TLS Properties" - }, - "url": { - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Runtime Url of the Backend." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "http", - "soap" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend communication protocol." - } - }, - "required": [ - "url", - "protocol" - ], - "description": "Parameters supplied to the Create Backend operation." - }, - "BackendCredentialsContract": { - "type": "object", - "properties": { - "certificate": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of Client Certificate Thumbprint." - }, - "query": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Query Parameter description." - }, - "header": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Header Parameter description." - }, - "authorization": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAuthorizationHeaderCredentials" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Authorization header authentication" - } - }, - "description": "Details of the Credentials used to connect to Backend." - }, - "BackendProperties": { - "type": "object", - "properties": { - "serviceFabricCluster": { - "oneOf": [ - { - "$ref": "#/definitions/BackendServiceFabricClusterProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend Service Fabric Cluster Properties" - } - }, - "description": "Properties specific to the Backend Type." - }, - "BackendProxyContract": { - "type": "object", - "properties": { - "url": { - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings." - }, - "username": { - "type": "string", - "description": "Username to connect to the WebProxy server" - }, - "password": { - "type": "string", - "description": "Password to connect to the WebProxy Server" - } - }, - "required": [ - "url" - ], - "description": "Details of the Backend WebProxy Server to use in the Request to Backend." - }, - "BackendServiceFabricClusterProperties": { - "type": "object", - "properties": { - "clientCertificatethumbprint": { - "type": "string", - "description": "The client certificate thumbprint for the management endpoint." - }, - "maxPartitionResolutionRetries": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum number of retries while attempting resolve the parition." - }, - "managementEndpoints": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The cluster management endpoint." - }, - "serverCertificateThumbprints": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Thumbprints of certificates cluster management service uses for tls communication" - }, - "serverX509Names": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X509CertificateName" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Server X509 Certificate Names Collection" - } - }, - "required": [ - "clientCertificatethumbprint", - "managementEndpoints" - ], - "description": "Properties of the Service Fabric Type Backend." - }, - "BackendTlsProperties": { - "type": "object", - "properties": { - "validateCertificateChain": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host." - }, - "validateCertificateName": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host." - } - }, - "description": "Properties controlling TLS Certificate Validation." - }, - "CertificateConfiguration": { - "type": "object", - "properties": { - "encodedCertificate": { - "type": "string", - "description": "Base64 Encoded certificate." - }, - "certificatePassword": { - "type": "string", - "description": "Certificate Password." - }, - "storeName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "CertificateAuthority", - "Root" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The local certificate store location. Only Root and CertificateAuthority are valid locations." - } - }, - "required": [ - "storeName" - ], - "description": "Certificate configuration which consist of non-trusted intermediates and root certificates." - }, - "CertificateCreateOrUpdateProperties": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." - }, - "password": { - "type": "string", - "description": "Password for the Certificate" - } - }, - "required": [ - "data", - "password" - ], - "description": "Parameters supplied to the CreateOrUpdate certificate operation." - }, - "EmailTemplateParametersContractProperties": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[A-Za-z0-9-._]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Template parameter name." - }, - "title": { - "type": "string", - "minLength": 1, - "maxLength": 4096, - "description": "Template parameter title." - }, - "description": { - "oneOf": [ - { - "type": "string", - "pattern": "^[A-Za-z0-9-._]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Template parameter description." - } - }, - "description": "Email Template Parameter contract." - }, - "EmailTemplateUpdateParameterProperties": { - "type": "object", - "properties": { - "subject": { - "type": "string", - "minLength": 1, - "maxLength": 1000, - "description": "Subject of the Template." - }, - "title": { - "type": "string", - "description": "Title of the Template." - }, - "description": { - "type": "string", - "description": "Description of the Email Template." - }, - "body": { - "type": "string", - "minLength": 1, - "description": "Email Template Body. This should be a valid XDocument" - }, - "parameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EmailTemplateParametersContractProperties" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Email Template Parameter values." - } - }, - "description": "Email Template Update Contract properties." - }, - "GroupCreateParametersProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "minLength": 1, - "maxLength": 300, - "description": "Group name." - }, - "description": { - "type": "string", - "description": "Group description." - }, - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "custom", - "system", - "external" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Group type." - }, - "externalId": { - "type": "string", - "description": "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." - } - }, - "required": [ - "displayName" - ], - "description": "Parameters supplied to the Create Group operation." - }, - "HostnameConfiguration": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Proxy", - "Portal", - "Management", - "Scm" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Hostname type." - }, - "hostName": { - "type": "string", - "description": "Hostname to configure on the Api Management service." - }, - "keyVaultId": { - "type": "string", - "description": "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*" - }, - "encodedCertificate": { - "type": "string", - "description": "Base64 Encoded certificate." - }, - "certificatePassword": { - "type": "string", - "description": "Certificate Password." - }, - "defaultSslBinding": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "negotiateClientCertificate": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specify true to always negotiate client certificate on the hostname. Default Value is false." - } - }, - "required": [ - "type", - "hostName" - ], - "description": "Custom hostname configuration." - }, - "IdentityProviderContractProperties": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "facebook", - "google", - "microsoft", - "twitter", - "aad", - "aadB2C" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identity Provider Type identifier." - }, - "allowedTenants": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of Allowed Tenants when configuring Azure Active Directory login." - }, - "signupPolicyName": { - "type": "string", - "minLength": 1, - "description": "Signup Policy Name. Only applies to AAD B2C Identity Provider." - }, - "signinPolicyName": { - "type": "string", - "minLength": 1, - "description": "Signin Policy Name. Only applies to AAD B2C Identity Provider." - }, - "profileEditingPolicyName": { - "type": "string", - "minLength": 1, - "description": "Profile Editing Policy Name. Only applies to AAD B2C Identity Provider." - }, - "passwordResetPolicyName": { - "type": "string", - "minLength": 1, - "description": "Password Reset Policy Name. Only applies to AAD B2C Identity Provider." - }, - "clientId": { - "type": "string", - "minLength": 1, - "description": "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": { - "type": "string", - "minLength": 1, - "description": "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." - } - }, - "required": [ - "clientId", - "clientSecret" - ], - "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users." - }, - "LoggerContractProperties": { - "type": "object", - "properties": { - "loggerType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "azureEventHub" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Logger type." - }, - "description": { - "type": "string", - "maxLength": 256, - "description": "Logger description." - }, - "credentials": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name and SendRule connection string of the event hub." - }, - "isBuffered": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." - } - }, - "required": [ - "loggerType", - "credentials" - ], - "description": "The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs." - }, - "OAuth2AuthenticationSettingsContract": { - "type": "object", - "properties": { - "authorizationServerId": { - "type": "string", - "description": "OAuth authorization server identifier." - }, - "scope": { - "type": "string", - "description": "operations scope." - } - }, - "description": "API OAuth2 Authentication settings details." - }, - "OpenidConnectProviderContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "maxLength": 50, - "description": "User-friendly OpenID Connect Provider name." - }, - "description": { - "type": "string", - "description": "User-friendly description of OpenID Connect Provider." - }, - "metadataEndpoint": { - "type": "string", - "description": "Metadata endpoint URI." - }, - "clientId": { - "type": "string", - "description": "Client ID of developer console which is the client application." - }, - "clientSecret": { - "type": "string", - "description": "Client Secret of developer console which is the client application." - } - }, - "required": [ - "displayName", - "metadataEndpoint", - "clientId" - ], - "description": "OpenID Connect Providers Contract." - }, - "OperationContractProperties": { - "type": "object", - "properties": { - "templateParameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of URL template parameters." - }, - "description": { - "type": "string", - "maxLength": 1000, - "description": "Description of the operation. May include HTML formatting tags." - }, - "request": { - "oneOf": [ - { - "$ref": "#/definitions/RequestContract" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An entity containing request details." - }, - "responses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResponseContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of Operation responses." - }, - "policies": { - "type": "string", - "description": "Operation Policies" - }, - "displayName": { - "type": "string", - "minLength": 1, - "maxLength": 300, - "description": "Operation Name." - }, - "method": { - "type": "string", - "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them." - }, - "urlTemplate": { - "type": "string", - "minLength": 1, - "maxLength": 1000, - "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}" - } - }, - "required": [ - "displayName", - "method", - "urlTemplate" - ], - "description": "Operation Contract Properties" - }, - "ParameterContract": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Parameter name." - }, - "description": { - "type": "string", - "description": "Parameter description." - }, - "type": { - "type": "string", - "description": "Parameter type." - }, - "defaultValue": { - "type": "string", - "description": "Default parameter value." - }, - "required": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "whether parameter is required or not." - }, - "values": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Parameter values." - } - }, - "required": [ - "name", - "type" - ], - "description": "Operation parameters details." - }, - "PolicyContractProperties": { - "type": "object", - "properties": { - "policyContent": { - "type": "string", - "description": "Json escaped Xml Encoded contents of the Policy." - } - }, - "required": [ - "policyContent" - ], - "description": "Policy contract Properties." - }, - "ProductContractProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "minLength": 1, - "maxLength": 1000, - "description": "Product description. May include HTML formatting tags." - }, - "terms": { - "type": "string", - "description": "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." - }, - "subscriptionRequired": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true." - }, - "approvalRequired": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "subscriptionsLimit": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "notPublished", - "published" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished." - }, - "displayName": { - "type": "string", - "minLength": 1, - "maxLength": 300, - "description": "Product name." - } - }, - "required": [ - "displayName" - ], - "description": "Product profile." - }, - "PropertyContractProperties": { - "type": "object", - "properties": { - "tags": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Optional tags that when provided can be used to filter the property list." - }, - "secret": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Determines whether the value is a secret and should be encrypted or not. Default value is false." - }, - "displayName": { - "oneOf": [ - { - "type": "string", - "pattern": "^[A-Za-z0-9-._]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters." - }, - "value": { - "type": "string", - "minLength": 1, - "maxLength": 4096, - "description": "Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace." - } - }, - "required": [ - "displayName", - "value" - ], - "description": "Property Contract properties." - }, - "RepresentationContract": { - "type": "object", - "properties": { - "contentType": { - "type": "string", - "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." - }, - "sample": { - "type": "string", - "description": "An example of the representation." - }, - "schemaId": { - "type": "string", - "description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." - }, - "typeName": { - "type": "string", - "description": "Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." - }, - "formParameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.." - } - }, - "required": [ - "contentType" - ], - "description": "Operation request/response representation details." - }, - "RequestContract": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Operation request description." - }, - "queryParameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of operation request query parameters." - }, - "headers": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of operation request headers." - }, - "representations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RepresentationContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of operation request representations." - } - }, - "description": "Operation request details." - }, - "ResponseContract": { - "type": "object", - "properties": { - "statusCode": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Operation response HTTP status code." - }, - "description": { - "type": "string", - "description": "Operation response description." - }, - "representations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RepresentationContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of operation response representations." - }, - "headers": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of operation response headers." - } - }, - "required": [ - "statusCode" - ], - "description": "Operation response details." - }, - "SchemaContractProperties": { - "type": "object", - "properties": { - "contentType": { - "type": "string", - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/SchemaDocumentProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Schema Document." - } - }, - "required": [ - "contentType" - ], - "description": "Schema contract Properties." - }, - "SchemaDocumentProperties": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Json escaped string defining the document representing the Schema." - } - }, - "description": "Schema Document Properties." - }, - "service_apis_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "API identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "apis" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApiCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Api entity create of update properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis" - }, - "service_apis_operations_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Operation identifier within an API. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "operations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OperationContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Operation Contract." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis/operations" - }, - "service_apis_operations_policies_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "policy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier of the Policy." - }, - "type": { - "type": "string", - "enum": [ - "policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Policy." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis/operations/policies" - }, - "service_apis_policies_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "policy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier of the Policy." - }, - "type": { - "type": "string", - "enum": [ - "policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Policy." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis/policies" - }, - "service_apis_schemas_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Schema identifier within an API. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "schemas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SchemaContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Schema." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/apis/schemas" - }, - "service_authorizationServers_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the authorization server." - }, - "type": { - "type": "string", - "enum": [ - "authorizationServers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationServerContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the External OAuth authorization server Contract." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/authorizationServers" - }, - "service_backends_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "backends" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend entity contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/backends" - }, - "service_certificates_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CertificateCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Certificate create or update properties details." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/certificates" - }, - "service_groups_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Group identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "groups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/GroupCreateParametersProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties supplied to Create Group operation." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/groups" - }, - "service_groups_users_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/groups/users" - }, - "service_identityProviders_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "facebook", - "google", - "microsoft", - "twitter", - "aad", - "aadB2C" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identity Provider Type identifier." - }, - "type": { - "type": "string", - "enum": [ - "identityProviders" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IdentityProviderContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identity Provider contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/identityProviders" - }, - "service_loggers_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Logger identifier. Must be unique in the API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "loggers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoggerContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Logger entity contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/loggers" - }, - "service_notifications_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "RequestPublisherNotificationMessage", - "PurchasePublisherNotificationMessage", - "NewApplicationNotificationMessage", - "BCC", - "NewIssuePublisherNotificationMessage", - "AccountClosedPublisher", - "QuotaLimitApproachingPublisherNotificationMessage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Notification Name Identifier." - }, - "type": { - "type": "string", - "enum": [ - "notifications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/notifications" - }, - "service_notifications_recipientEmails_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Email identifier." - }, - "type": { - "type": "string", - "enum": [ - "recipientEmails" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/notifications/recipientEmails" - }, - "service_notifications_recipientUsers_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "recipientUsers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/notifications/recipientUsers" - }, - "service_openidConnectProviders_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the OpenID Connect Provider." - }, - "type": { - "type": "string", - "enum": [ - "openidConnectProviders" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OpenidConnectProviderContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "OpenId Connect Provider contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/openidConnectProviders" - }, - "service_policies_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "policy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier of the Policy." - }, - "type": { - "type": "string", - "enum": [ - "policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Policy." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/policies" - }, - "service_products_apis_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "API identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "apis" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products/apis" - }, - "service_products_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Product identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "products" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProductContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Product entity contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/products" - }, - "service_products_groups_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Group identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "groups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.ApiManagement/service/products/groups" - }, - "service_products_policies_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "policy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier of the Policy." - }, - "type": { - "type": "string", - "enum": [ - "policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the Policy." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/products/policies" - }, - "service_properties_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier of the property." - }, - "type": { - "type": "string", - "enum": [ - "properties" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PropertyContractProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Property entity contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/properties" - }, - "service_subscriptions_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management." - }, - "type": { - "type": "string", - "enum": [ - "subscriptions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubscriptionCreateParameterProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subscription contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/subscriptions" - }, - "service_templates_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "applicationApprovedNotificationMessage", - "accountClosedDeveloper", - "quotaLimitApproachingDeveloperNotificationMessage", - "newDeveloperNotificationMessage", - "emailChangeIdentityDefault", - "inviteUserNotificationMessage", - "newCommentNotificationMessage", - "confirmSignUpIdentityDefault", - "newIssueNotificationMessage", - "purchaseDeveloperNotificationMessage", - "passwordResetIdentityDefault", - "passwordResetByAdminNotificationMessage", - "rejectDeveloperNotificationMessage", - "requestDeveloperNotificationMessage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Email Template Name Identifier." - }, - "type": { - "type": "string", - "enum": [ - "templates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/EmailTemplateUpdateParameterProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Email Template Update contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/templates" - }, - "service_users_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[^*#&+:<>?]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User identifier. Must be unique in the current API Management service instance." - }, - "type": { - "type": "string", - "enum": [ - "users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/UserCreateParameterProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User entity create contract properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.ApiManagement/service/users" - }, - "SubscriptionCreateParameterProperties": { - "type": "object", - "properties": { - "userId": { - "type": "string", - "description": "User (user id path) for whom subscription is being created in form /users/{uid}" - }, - "productId": { - "type": "string", - "description": "Product (product id path) for which subscription is being created in form /products/{productid}" - }, - "displayName": { - "type": "string", - "minLength": 1, - "maxLength": 100, - "description": "Subscription name." - }, - "primaryKey": { - "type": "string", - "minLength": 1, - "maxLength": 256, - "description": "Primary subscription key. If not specified during request key will be generated automatically." - }, - "secondaryKey": { - "type": "string", - "minLength": 1, - "maxLength": 256, - "description": "Secondary subscription key. If not specified during request key will be generated automatically." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "suspended", - "active", - "expired", - "submitted", - "rejected", - "cancelled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated." - } - }, - "required": [ - "userId", - "productId", - "displayName" - ], - "description": "Parameters supplied to the Create subscription operation." - }, - "SubscriptionKeyParameterNamesContract": { - "type": "object", - "properties": { - "header": { - "type": "string", - "description": "Subscription key header name." - }, - "query": { - "type": "string", - "description": "Subscription key query string parameter name." - } - }, - "description": "Subscription key parameter names details." - }, - "TokenBodyParameterContract": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "body parameter name." - }, - "value": { - "type": "string", - "description": "body parameter value." - } - }, - "required": [ - "name", - "value" - ], - "description": "OAuth acquire token request body parameter (www-url-form-encoded)." - }, - "UserCreateParameterProperties": { - "type": "object", - "properties": { - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "active", - "blocked", - "pending", - "deleted" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "note": { - "type": "string", - "description": "Optional note about a user set by the administrator." - }, - "email": { - "type": "string", - "minLength": 1, - "maxLength": 254, - "description": "Email address. Must not be empty and must be unique within the service instance." - }, - "firstName": { - "type": "string", - "minLength": 1, - "maxLength": 100, - "description": "First name." - }, - "lastName": { - "type": "string", - "minLength": 1, - "maxLength": 100, - "description": "Last name." - }, - "password": { - "type": "string", - "description": "User Password. If no value is provided, a default password is generated." - }, - "confirmation": { - "oneOf": [ - { - "type": "string", - "enum": [ - "signup", - "invite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Determines the type of confirmation e-mail that will be sent to the newly created user." - } - }, - "required": [ - "email", - "firstName", - "lastName" - ], - "description": "Parameters supplied to the Create User operation." - }, - "VirtualNetworkConfiguration": { - "type": "object", - "properties": { - "subnetResourceId": { - "oneOf": [ - { - "type": "string", - "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." - } - }, - "description": "Configuration of a virtual network to which API Management service is deployed." - }, - "X509CertificateName": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Common Name of the Certificate." - }, - "issuerCertificateThumbprint": { - "type": "string", - "description": "Thumbprint for the Issuer of the Certificate." - } - }, - "description": "Properties of server X509Names." - } - } -} diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service.md b/test/Resource/Expected/ApiManagement/2017-03-01/service.md deleted file mode 100644 index bd85bcf..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service.md +++ /dev/null @@ -1,149 +0,0 @@ -# Microsoft.ApiManagement/service template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service", - "apiVersion": "2017-03-01", - "tags": {}, - "properties": { - "notificationSenderEmail": "string", - "hostnameConfigurations": [ - { - "type": "string", - "hostName": "string", - "keyVaultId": "string", - "encodedCertificate": "string", - "certificatePassword": "string", - "defaultSslBinding": "boolean", - "negotiateClientCertificate": "boolean" - } - ], - "virtualNetworkConfiguration": { - "subnetResourceId": "string" - }, - "additionalLocations": [ - { - "location": "string", - "sku": { - "name": "string", - "capacity": "integer" - }, - "virtualNetworkConfiguration": { - "subnetResourceId": "string" - } - } - ], - "customProperties": {}, - "certificates": [ - { - "encodedCertificate": "string", - "certificatePassword": "string", - "storeName": "string" - } - ], - "virtualNetworkType": "string", - "publisherEmail": "string", - "publisherName": "string" - }, - "sku": { - "name": "string", - "capacity": "integer" - }, - "identity": { - "type": "SystemAssigned" - }, - "location": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the API Management service. | -| type | enum | Yes | Microsoft.ApiManagement/service | -| apiVersion | enum | Yes | 2017-03-01 | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the API Management service. - [ApiManagementServiceProperties object](#ApiManagementServiceProperties) | -| sku | object | Yes | SKU properties of the API Management service. - [ApiManagementServiceSkuProperties object](#ApiManagementServiceSkuProperties) | -| identity | object | No | Managed service identity of the Api Management service. - [ApiManagementServiceIdentity object](#ApiManagementServiceIdentity) | -| location | string | Yes | Resource location. | -| resources | array | No | [users](./service/users.md) [subscriptions](./service/subscriptions.md) [properties](./service/properties.md) [products](./service/products.md) [openidConnectProviders](./service/openidConnectProviders.md) [notifications](./service/notifications.md) [loggers](./service/loggers.md) [identityProviders](./service/identityProviders.md) [groups](./service/groups.md) [templates](./service/templates.md) [certificates](./service/certificates.md) [backends](./service/backends.md) [authorizationServers](./service/authorizationServers.md) [apis](./service/apis.md) [policies](./service/policies.md) | - - - -### ApiManagementServiceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| notificationSenderEmail | string | No | Email address from which the notification will be sent. | -| hostnameConfigurations | array | No | Custom hostname configuration of the API Management service. - [HostnameConfiguration object](#HostnameConfiguration) | -| virtualNetworkConfiguration | object | No | Virtual network configuration of the API Management service. - [VirtualNetworkConfiguration object](#VirtualNetworkConfiguration) | -| additionalLocations | array | No | Additional datacenter locations of the API Management service. - [AdditionalLocation object](#AdditionalLocation) | -| customProperties | object | No | 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. | -| certificates | array | No | List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. - [CertificateConfiguration object](#CertificateConfiguration) | -| virtualNetworkType | enum | No | The type of VPN in which API Managemet 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. - None, External, Internal | -| publisherEmail | string | Yes | Publisher email. | -| publisherName | string | Yes | Publisher name. | - - - -### ApiManagementServiceSkuProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Name of the Sku. - Developer, Standard, Premium, Basic | -| capacity | integer | No | Capacity of the SKU (number of deployed units of the SKU). The default value is 1. | - - - -### ApiManagementServiceIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | Yes | The identity type. Currently the only supported type is 'SystemAssigned'. - SystemAssigned | - - - -### HostnameConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | Yes | Hostname type. - Proxy, Portal, Management, Scm | -| hostName | string | Yes | Hostname to configure on the Api Management service. | -| keyVaultId | string | No | 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* | -| encodedCertificate | string | No | Base64 Encoded certificate. | -| certificatePassword | string | No | Certificate Password. | -| defaultSslBinding | boolean | No | 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. | -| negotiateClientCertificate | boolean | No | Specify true to always negotiate client certificate on the hostname. Default Value is false. | - - - -### VirtualNetworkConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnetResourceId | string | No | The full resource ID of a subnet in a virtual network to deploy the API Management service in. | - - - -### AdditionalLocation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| location | string | Yes | The location name of the additional region among Azure Data center regions. | -| sku | object | Yes | SKU properties of the API Management service. - [ApiManagementServiceSkuProperties object](#ApiManagementServiceSkuProperties) | -| virtualNetworkConfiguration | object | No | Virtual network configuration for the location. - [VirtualNetworkConfiguration object](#VirtualNetworkConfiguration) | - - - -### CertificateConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| encodedCertificate | string | No | Base64 Encoded certificate. | -| certificatePassword | string | No | Certificate Password. | -| storeName | enum | Yes | The local certificate store location. Only Root and CertificateAuthority are valid locations. - CertificateAuthority or Root | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/apis.md deleted file mode 100644 index e8fac42..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis.md +++ /dev/null @@ -1,108 +0,0 @@ -# Microsoft.ApiManagement/service/apis template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/apis resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/apis", - "apiVersion": "2017-03-01", - "properties": { - "description": "string", - "authenticationSettings": { - "oAuth2": { - "authorizationServerId": "string", - "scope": "string" - } - }, - "subscriptionKeyParameterNames": { - "header": "string", - "query": "string" - }, - "type": "string", - "apiRevision": "string", - "isCurrent": "boolean", - "isOnline": "boolean", - "displayName": "string", - "serviceUrl": "string", - "path": "string", - "protocols": [ - "string" - ], - "contentValue": "string", - "contentFormat": "string", - "wsdlSelector": { - "wsdlServiceName": "string", - "wsdlEndpointName": "string" - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/apis object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | API identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/apis | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Api entity create of update properties. - [ApiCreateOrUpdateProperties object](#ApiCreateOrUpdateProperties) | -| resources | array | No | [schemas](./apis/schemas.md) [policies](./apis/policies.md) [operations](./apis/operations.md) | - - - -### ApiCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Description of the API. May include HTML formatting tags. | -| authenticationSettings | object | No | Collection of authentication settings included into this API. - [AuthenticationSettingsContract object](#AuthenticationSettingsContract) | -| subscriptionKeyParameterNames | object | No | Protocols over which API is made available. - [SubscriptionKeyParameterNamesContract object](#SubscriptionKeyParameterNamesContract) | -| type | enum | No | Type of API. - http or soap | -| apiRevision | string | No | Describes the Revision of the Api. If no value is provided, default revision 1 is created | -| isCurrent | boolean | No | Indicates if API revision is current api revision. | -| isOnline | boolean | No | Indicates if API revision is accessible via the gateway. | -| displayName | string | No | API name. | -| serviceUrl | string | No | Absolute URL of the backend service implementing this API. | -| path | string | Yes | Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. | -| protocols | array | No | Describes on which protocols the operations in this API can be invoked. - http or https | -| contentValue | string | No | Content value when Importing an API. | -| contentFormat | enum | No | Format of the Content in which the API is getting imported. - wadl-xml, wadl-link-json, swagger-json, swagger-link-json, wsdl, wsdl-link | -| wsdlSelector | object | No | Criteria to limit import of WSDL to a subset of the document. - [ApiCreateOrUpdatePropertiesWsdlSelector object](#ApiCreateOrUpdatePropertiesWsdlSelector) | - - - -### AuthenticationSettingsContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| oAuth2 | object | No | OAuth2 Authentication settings - [OAuth2AuthenticationSettingsContract object](#OAuth2AuthenticationSettingsContract) | - - - -### SubscriptionKeyParameterNamesContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| header | string | No | Subscription key header name. | -| query | string | No | Subscription key query string parameter name. | - - - -### ApiCreateOrUpdatePropertiesWsdlSelector object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| wsdlServiceName | string | No | Name of service to import from WSDL | -| wsdlEndpointName | string | No | Name of endpoint(port) to import from WSDL | - - - -### OAuth2AuthenticationSettingsContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationServerId | string | No | OAuth authorization server identifier. | -| scope | string | No | operations scope. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/operations.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/operations.md deleted file mode 100644 index da2bdf2..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/operations.md +++ /dev/null @@ -1,189 +0,0 @@ -# Microsoft.ApiManagement/service/apis/operations template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/apis/operations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/apis/operations", - "apiVersion": "2017-03-01", - "properties": { - "templateParameters": [ - { - "name": "string", - "description": "string", - "type": "string", - "defaultValue": "string", - "required": "boolean", - "values": [ - "string" - ] - } - ], - "description": "string", - "request": { - "description": "string", - "queryParameters": [ - { - "name": "string", - "description": "string", - "type": "string", - "defaultValue": "string", - "required": "boolean", - "values": [ - "string" - ] - } - ], - "headers": [ - { - "name": "string", - "description": "string", - "type": "string", - "defaultValue": "string", - "required": "boolean", - "values": [ - "string" - ] - } - ], - "representations": [ - { - "contentType": "string", - "sample": "string", - "schemaId": "string", - "typeName": "string", - "formParameters": [ - { - "name": "string", - "description": "string", - "type": "string", - "defaultValue": "string", - "required": "boolean", - "values": [ - "string" - ] - } - ] - } - ] - }, - "responses": [ - { - "statusCode": "integer", - "description": "string", - "representations": [ - { - "contentType": "string", - "sample": "string", - "schemaId": "string", - "typeName": "string", - "formParameters": [ - { - "name": "string", - "description": "string", - "type": "string", - "defaultValue": "string", - "required": "boolean", - "values": [ - "string" - ] - } - ] - } - ], - "headers": [ - { - "name": "string", - "description": "string", - "type": "string", - "defaultValue": "string", - "required": "boolean", - "values": [ - "string" - ] - } - ] - } - ], - "policies": "string", - "displayName": "string", - "method": "string", - "urlTemplate": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/apis/operations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Operation identifier within an API. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/apis/operations | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Properties of the Operation Contract. - [OperationContractProperties object](#OperationContractProperties) | -| resources | array | No | [policies](./operations/policies.md) | - - - -### OperationContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| templateParameters | array | No | Collection of URL template parameters. - [ParameterContract object](#ParameterContract) | -| description | string | No | Description of the operation. May include HTML formatting tags. | -| request | object | No | An entity containing request details. - [RequestContract object](#RequestContract) | -| responses | array | No | Array of Operation responses. - [ResponseContract object](#ResponseContract) | -| policies | string | No | Operation Policies | -| displayName | string | Yes | Operation Name. | -| method | string | Yes | A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. | -| urlTemplate | string | Yes | Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} | - - - -### ParameterContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Parameter name. | -| description | string | No | Parameter description. | -| type | string | Yes | Parameter type. | -| defaultValue | string | No | Default parameter value. | -| required | boolean | No | whether parameter is required or not. | -| values | array | No | Parameter values. - string | - - - -### RequestContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Operation request description. | -| queryParameters | array | No | Collection of operation request query parameters. - [ParameterContract object](#ParameterContract) | -| headers | array | No | Collection of operation request headers. - [ParameterContract object](#ParameterContract) | -| representations | array | No | Collection of operation request representations. - [RepresentationContract object](#RepresentationContract) | - - - -### ResponseContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| statusCode | integer | Yes | Operation response HTTP status code. | -| description | string | No | Operation response description. | -| representations | array | No | Collection of operation response representations. - [RepresentationContract object](#RepresentationContract) | -| headers | array | No | Collection of operation response headers. - [ParameterContract object](#ParameterContract) | - - - -### RepresentationContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| contentType | string | Yes | Specifies a registered or custom content type for this representation, e.g. application/xml. | -| sample | string | No | An example of the representation. | -| schemaId | string | No | Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. | -| typeName | string | No | Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. | -| formParameters | array | No | Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. - [ParameterContract object](#ParameterContract) | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/operations/policies.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/operations/policies.md deleted file mode 100644 index 6b3e24f..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/operations/policies.md +++ /dev/null @@ -1,36 +0,0 @@ -# Microsoft.ApiManagement/service/apis/operations/policies template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/apis/operations/policies resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "policy", - "type": "Microsoft.ApiManagement/service/apis/operations/policies", - "apiVersion": "2017-03-01", - "properties": { - "policyContent": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/apis/operations/policies object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The identifier of the Policy. - policy | -| type | enum | Yes | Microsoft.ApiManagement/service/apis/operations/policies | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Properties of the Policy. - [PolicyContractProperties object](#PolicyContractProperties) | - - - -### PolicyContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| policyContent | string | Yes | Json escaped Xml Encoded contents of the Policy. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/policies.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/policies.md deleted file mode 100644 index b23748b..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/policies.md +++ /dev/null @@ -1,36 +0,0 @@ -# Microsoft.ApiManagement/service/apis/policies template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/apis/policies resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "policy", - "type": "Microsoft.ApiManagement/service/apis/policies", - "apiVersion": "2017-03-01", - "properties": { - "policyContent": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/apis/policies object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The identifier of the Policy. - policy | -| type | enum | Yes | Microsoft.ApiManagement/service/apis/policies | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Properties of the Policy. - [PolicyContractProperties object](#PolicyContractProperties) | - - - -### PolicyContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| policyContent | string | Yes | Json escaped Xml Encoded contents of the Policy. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/schemas.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/schemas.md deleted file mode 100644 index 3d176b0..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/apis/schemas.md +++ /dev/null @@ -1,47 +0,0 @@ -# Microsoft.ApiManagement/service/apis/schemas template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/apis/schemas resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/apis/schemas", - "apiVersion": "2017-03-01", - "properties": { - "contentType": "string", - "document": { - "value": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/apis/schemas object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Schema identifier within an API. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/apis/schemas | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Properties of the Schema. - [SchemaContractProperties object](#SchemaContractProperties) | - - - -### SchemaContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| contentType | string | Yes | 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 | object | No | Properties of the Schema Document. - [SchemaDocumentProperties object](#SchemaDocumentProperties) | - - - -### SchemaDocumentProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | string | No | Json escaped string defining the document representing the Schema. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/authorizationServers.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/authorizationServers.md deleted file mode 100644 index ef909dd..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/authorizationServers.md +++ /dev/null @@ -1,87 +0,0 @@ -# Microsoft.ApiManagement/service/authorizationServers template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/authorizationServers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/authorizationServers", - "apiVersion": "2017-03-01", - "properties": { - "description": "string", - "authorizationMethods": [ - "string" - ], - "clientAuthenticationMethod": [ - "string" - ], - "tokenBodyParameters": [ - { - "name": "string", - "value": "string" - } - ], - "tokenEndpoint": "string", - "supportState": "boolean", - "defaultScope": "string", - "bearerTokenSendingMethods": [ - "string" - ], - "clientSecret": "string", - "resourceOwnerUsername": "string", - "resourceOwnerPassword": "string", - "displayName": "string", - "clientRegistrationEndpoint": "string", - "authorizationEndpoint": "string", - "grantTypes": [ - "string" - ], - "clientId": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/authorizationServers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the authorization server. | -| type | enum | Yes | Microsoft.ApiManagement/service/authorizationServers | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Properties of the External OAuth authorization server Contract. - [AuthorizationServerContractProperties object](#AuthorizationServerContractProperties) | - - - -### AuthorizationServerContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Description of the authorization server. Can contain HTML formatting tags. | -| authorizationMethods | array | No | HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. - HEAD, OPTIONS, TRACE, GET, POST, PUT, PATCH, DELETE | -| clientAuthenticationMethod | array | No | Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. - Basic or Body | -| tokenBodyParameters | array | No | 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"}. - [TokenBodyParameterContract object](#TokenBodyParameterContract) | -| tokenEndpoint | string | No | OAuth token endpoint. Contains absolute URI to entity being referenced. | -| supportState | boolean | No | If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. | -| defaultScope | string | No | Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. | -| bearerTokenSendingMethods | array | No | Specifies the mechanism by which access token is passed to the API. - authorizationHeader or query | -| clientSecret | string | No | Client or app secret registered with this authorization server. | -| resourceOwnerUsername | string | No | Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. | -| resourceOwnerPassword | string | No | Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. | -| displayName | string | Yes | User-friendly authorization server name. | -| clientRegistrationEndpoint | string | Yes | Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. | -| authorizationEndpoint | string | Yes | OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. | -| grantTypes | array | Yes | Form of an authorization grant, which the client uses to request the access token. - authorizationCode, implicit, resourceOwnerPassword, clientCredentials | -| clientId | string | Yes | Client or app id registered with this authorization server. | - - - -### TokenBodyParameterContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | body parameter name. | -| value | string | Yes | body parameter value. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/backends.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/backends.md deleted file mode 100644 index be0b5da..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/backends.md +++ /dev/null @@ -1,147 +0,0 @@ -# Microsoft.ApiManagement/service/backends template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/backends resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/backends", - "apiVersion": "2017-03-01", - "properties": { - "title": "string", - "description": "string", - "resourceId": "string", - "properties": { - "serviceFabricCluster": { - "clientCertificatethumbprint": "string", - "maxPartitionResolutionRetries": "integer", - "managementEndpoints": [ - "string" - ], - "serverCertificateThumbprints": [ - "string" - ], - "serverX509Names": [ - { - "name": "string", - "issuerCertificateThumbprint": "string" - } - ] - } - }, - "credentials": { - "certificate": [ - "string" - ], - "query": {}, - "header": {}, - "authorization": { - "scheme": "string", - "parameter": "string" - } - }, - "proxy": { - "url": "string", - "username": "string", - "password": "string" - }, - "tls": { - "validateCertificateChain": "boolean", - "validateCertificateName": "boolean" - }, - "url": "string", - "protocol": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/backends object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the Backend entity. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/backends | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Backend entity contract properties. - [BackendContractProperties object](#BackendContractProperties) | - - - -### BackendContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| title | string | No | Backend Title. | -| description | string | No | Backend Description. | -| resourceId | string | No | Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. | -| properties | object | No | Backend Properties contract - [BackendProperties object](#BackendProperties) | -| credentials | object | No | Backend Credentials Contract Properties - [BackendCredentialsContract object](#BackendCredentialsContract) | -| proxy | object | No | Backend Proxy Contract Properties - [BackendProxyContract object](#BackendProxyContract) | -| tls | object | No | Backend TLS Properties - [BackendTlsProperties object](#BackendTlsProperties) | -| url | string | Yes | Runtime Url of the Backend. | -| protocol | enum | Yes | Backend communication protocol. - http or soap | - - - -### BackendProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceFabricCluster | object | No | Backend Service Fabric Cluster Properties - [BackendServiceFabricClusterProperties object](#BackendServiceFabricClusterProperties) | - - - -### BackendCredentialsContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificate | array | No | List of Client Certificate Thumbprint. - string | -| query | object | No | Query Parameter description. | -| header | object | No | Header Parameter description. | -| authorization | object | No | Authorization header authentication - [BackendAuthorizationHeaderCredentials object](#BackendAuthorizationHeaderCredentials) | - - - -### BackendProxyContract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| url | string | Yes | WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. | -| username | string | No | Username to connect to the WebProxy server | -| password | string | No | Password to connect to the WebProxy Server | - - - -### BackendTlsProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| validateCertificateChain | boolean | No | Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. | -| validateCertificateName | boolean | No | Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. | - - - -### BackendServiceFabricClusterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| clientCertificatethumbprint | string | Yes | The client certificate thumbprint for the management endpoint. | -| maxPartitionResolutionRetries | integer | No | Maximum number of retries while attempting resolve the parition. | -| managementEndpoints | array | Yes | The cluster management endpoint. - string | -| serverCertificateThumbprints | array | No | Thumbprints of certificates cluster management service uses for tls communication - string | -| serverX509Names | array | No | Server X509 Certificate Names Collection - [X509CertificateName object](#X509CertificateName) | - - - -### BackendAuthorizationHeaderCredentials object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| scheme | string | Yes | Authentication Scheme name. | -| parameter | string | Yes | Authentication Parameter value. | - - - -### X509CertificateName object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Common Name of the Certificate. | -| issuerCertificateThumbprint | string | No | Thumbprint for the Issuer of the Certificate. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/certificates.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/certificates.md deleted file mode 100644 index 4255bf7..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/certificates.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.ApiManagement/service/certificates template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/certificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/certificates", - "apiVersion": "2017-03-01", - "properties": { - "data": "string", - "password": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/certificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the certificate entity. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/certificates | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Certificate create or update properties details. - [CertificateCreateOrUpdateProperties object](#CertificateCreateOrUpdateProperties) | - - - -### CertificateCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | Yes | Base 64 encoded certificate using the application/x-pkcs12 representation. | -| password | string | Yes | Password for the Certificate | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/groups.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/groups.md deleted file mode 100644 index 596aff2..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/groups.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.ApiManagement/service/groups template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/groups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/groups", - "apiVersion": "2017-03-01", - "properties": { - "displayName": "string", - "description": "string", - "type": "string", - "externalId": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/groups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/groups | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Properties supplied to Create Group operation. - [GroupCreateParametersProperties object](#GroupCreateParametersProperties) | -| resources | array | No | [users](./groups/users.md) | - - - -### GroupCreateParametersProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| displayName | string | Yes | Group name. | -| description | string | No | Group description. | -| type | enum | No | Group type. - custom, system, external | -| externalId | string | No | 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. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/groups/users.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/groups/users.md deleted file mode 100644 index 52cf5c7..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/groups/users.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.ApiManagement/service/groups/users template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/groups/users resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/groups/users", - "apiVersion": "2017-03-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/groups/users object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | User identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/groups/users | -| apiVersion | enum | Yes | 2017-03-01 | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/identityProviders.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/identityProviders.md deleted file mode 100644 index 2134512..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/identityProviders.md +++ /dev/null @@ -1,52 +0,0 @@ -# Microsoft.ApiManagement/service/identityProviders template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/identityProviders resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/identityProviders", - "apiVersion": "2017-03-01", - "properties": { - "type": "string", - "allowedTenants": [ - "string" - ], - "signupPolicyName": "string", - "signinPolicyName": "string", - "profileEditingPolicyName": "string", - "passwordResetPolicyName": "string", - "clientId": "string", - "clientSecret": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/identityProviders object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Identity Provider Type identifier. - facebook, google, microsoft, twitter, aad, aadB2C | -| type | enum | Yes | Microsoft.ApiManagement/service/identityProviders | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Identity Provider contract properties. - [IdentityProviderContractProperties object](#IdentityProviderContractProperties) | - - - -### IdentityProviderContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | No | Identity Provider Type identifier. - facebook, google, microsoft, twitter, aad, aadB2C | -| allowedTenants | array | No | List of Allowed Tenants when configuring Azure Active Directory login. - string | -| signupPolicyName | string | No | Signup Policy Name. Only applies to AAD B2C Identity Provider. | -| signinPolicyName | string | No | Signin Policy Name. Only applies to AAD B2C Identity Provider. | -| profileEditingPolicyName | string | No | Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. | -| passwordResetPolicyName | string | No | Password Reset Policy Name. Only applies to AAD B2C Identity Provider. | -| clientId | string | Yes | 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 | Yes | 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. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/loggers.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/loggers.md deleted file mode 100644 index eadac33..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/loggers.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.ApiManagement/service/loggers template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/loggers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/loggers", - "apiVersion": "2017-03-01", - "properties": { - "loggerType": "azureEventHub", - "description": "string", - "credentials": {}, - "isBuffered": "boolean" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/loggers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Logger identifier. Must be unique in the API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/loggers | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Logger entity contract properties. - [LoggerContractProperties object](#LoggerContractProperties) | - - - -### LoggerContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| loggerType | enum | Yes | Logger type. - azureEventHub | -| description | string | No | Logger description. | -| credentials | object | Yes | The name and SendRule connection string of the event hub. | -| isBuffered | boolean | No | Whether records are buffered in the logger before publishing. Default is assumed to be true. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/notifications.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/notifications.md deleted file mode 100644 index d36d514..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/notifications.md +++ /dev/null @@ -1,27 +0,0 @@ -# Microsoft.ApiManagement/service/notifications template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/notifications resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/notifications", - "apiVersion": "2017-03-01", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/notifications object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Notification Name Identifier. - RequestPublisherNotificationMessage, PurchasePublisherNotificationMessage, NewApplicationNotificationMessage, BCC, NewIssuePublisherNotificationMessage, AccountClosedPublisher, QuotaLimitApproachingPublisherNotificationMessage | -| type | enum | Yes | Microsoft.ApiManagement/service/notifications | -| apiVersion | enum | Yes | 2017-03-01 | -| resources | array | No | [recipientEmails](./notifications/recipientEmails.md) [recipientUsers](./notifications/recipientUsers.md) | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/notifications/recipientEmails.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/notifications/recipientEmails.md deleted file mode 100644 index a0d5b08..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/notifications/recipientEmails.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.ApiManagement/service/notifications/recipientEmails template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/notifications/recipientEmails resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", - "apiVersion": "2017-03-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/notifications/recipientEmails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Email identifier. | -| type | enum | Yes | Microsoft.ApiManagement/service/notifications/recipientEmails | -| apiVersion | enum | Yes | 2017-03-01 | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/notifications/recipientUsers.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/notifications/recipientUsers.md deleted file mode 100644 index c55bf48..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/notifications/recipientUsers.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.ApiManagement/service/notifications/recipientUsers template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/notifications/recipientUsers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", - "apiVersion": "2017-03-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/notifications/recipientUsers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | User identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/notifications/recipientUsers | -| apiVersion | enum | Yes | 2017-03-01 | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/openidConnectProviders.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/openidConnectProviders.md deleted file mode 100644 index 6f13802..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/openidConnectProviders.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.ApiManagement/service/openidConnectProviders template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/openidConnectProviders resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/openidConnectProviders", - "apiVersion": "2017-03-01", - "properties": { - "displayName": "string", - "description": "string", - "metadataEndpoint": "string", - "clientId": "string", - "clientSecret": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/openidConnectProviders object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the OpenID Connect Provider. | -| type | enum | Yes | Microsoft.ApiManagement/service/openidConnectProviders | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | OpenId Connect Provider contract properties. - [OpenidConnectProviderContractProperties object](#OpenidConnectProviderContractProperties) | - - - -### OpenidConnectProviderContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| displayName | string | Yes | User-friendly OpenID Connect Provider name. | -| description | string | No | User-friendly description of OpenID Connect Provider. | -| metadataEndpoint | string | Yes | Metadata endpoint URI. | -| clientId | string | Yes | Client ID of developer console which is the client application. | -| clientSecret | string | No | Client Secret of developer console which is the client application. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/policies.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/policies.md deleted file mode 100644 index b4339fe..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/policies.md +++ /dev/null @@ -1,36 +0,0 @@ -# Microsoft.ApiManagement/service/policies template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/policies resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "policy", - "type": "Microsoft.ApiManagement/service/policies", - "apiVersion": "2017-03-01", - "properties": { - "policyContent": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/policies object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The identifier of the Policy. - policy | -| type | enum | Yes | Microsoft.ApiManagement/service/policies | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Properties of the Policy. - [PolicyContractProperties object](#PolicyContractProperties) | - - - -### PolicyContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| policyContent | string | Yes | Json escaped Xml Encoded contents of the Policy. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/products.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/products.md deleted file mode 100644 index 028524b..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/products.md +++ /dev/null @@ -1,50 +0,0 @@ -# Microsoft.ApiManagement/service/products template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/products resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/products", - "apiVersion": "2017-03-01", - "properties": { - "description": "string", - "terms": "string", - "subscriptionRequired": "boolean", - "approvalRequired": "boolean", - "subscriptionsLimit": "integer", - "state": "string", - "displayName": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/products object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Product identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/products | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Product entity contract properties. - [ProductContractProperties object](#ProductContractProperties) | -| resources | array | No | [policies](./products/policies.md) [groups](./products/groups.md) [apis](./products/apis.md) | - - - -### ProductContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Product description. May include HTML formatting tags. | -| terms | string | No | 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. | -| subscriptionRequired | boolean | No | Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. | -| approvalRequired | boolean | No | 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. | -| subscriptionsLimit | integer | No | 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. | -| state | enum | No | whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. - notPublished or published | -| displayName | string | Yes | Product name. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/products/apis.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/products/apis.md deleted file mode 100644 index c2bb738..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/products/apis.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.ApiManagement/service/products/apis template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/products/apis resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/products/apis", - "apiVersion": "2017-03-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/products/apis object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | API identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/products/apis | -| apiVersion | enum | Yes | 2017-03-01 | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/products/groups.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/products/groups.md deleted file mode 100644 index 901c569..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/products/groups.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.ApiManagement/service/products/groups template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/products/groups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/products/groups", - "apiVersion": "2017-03-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/products/groups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Group identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/products/groups | -| apiVersion | enum | Yes | 2017-03-01 | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/products/policies.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/products/policies.md deleted file mode 100644 index d515336..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/products/policies.md +++ /dev/null @@ -1,36 +0,0 @@ -# Microsoft.ApiManagement/service/products/policies template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/products/policies resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "policy", - "type": "Microsoft.ApiManagement/service/products/policies", - "apiVersion": "2017-03-01", - "properties": { - "policyContent": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/products/policies object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The identifier of the Policy. - policy | -| type | enum | Yes | Microsoft.ApiManagement/service/products/policies | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Properties of the Policy. - [PolicyContractProperties object](#PolicyContractProperties) | - - - -### PolicyContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| policyContent | string | Yes | Json escaped Xml Encoded contents of the Policy. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/properties.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/properties.md deleted file mode 100644 index c705ba6..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/properties.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.ApiManagement/service/properties template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/properties resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/properties", - "apiVersion": "2017-03-01", - "properties": { - "tags": [ - "string" - ], - "secret": "boolean", - "displayName": "string", - "value": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/properties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Identifier of the property. | -| type | enum | Yes | Microsoft.ApiManagement/service/properties | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Property entity contract properties. - [PropertyContractProperties object](#PropertyContractProperties) | - - - -### PropertyContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| tags | array | No | Optional tags that when provided can be used to filter the property list. - string | -| secret | boolean | No | Determines whether the value is a secret and should be encrypted or not. Default value is false. | -| displayName | string | Yes | Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters. | -| value | string | Yes | Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/subscriptions.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/subscriptions.md deleted file mode 100644 index 72b924f..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/subscriptions.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.ApiManagement/service/subscriptions template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/subscriptions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/subscriptions", - "apiVersion": "2017-03-01", - "properties": { - "userId": "string", - "productId": "string", - "displayName": "string", - "primaryKey": "string", - "secondaryKey": "string", - "state": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/subscriptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Subscription entity Identifier. The entity represents the association between a user and a product in API Management. | -| type | enum | Yes | Microsoft.ApiManagement/service/subscriptions | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Subscription contract properties. - [SubscriptionCreateParameterProperties object](#SubscriptionCreateParameterProperties) | - - - -### SubscriptionCreateParameterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| userId | string | Yes | User (user id path) for whom subscription is being created in form /users/{uid} | -| productId | string | Yes | Product (product id path) for which subscription is being created in form /products/{productid} | -| displayName | string | Yes | Subscription name. | -| primaryKey | string | No | Primary subscription key. If not specified during request key will be generated automatically. | -| secondaryKey | string | No | Secondary subscription key. If not specified during request key will be generated automatically. | -| state | enum | No | Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. - suspended, active, expired, submitted, rejected, cancelled | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/templates.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/templates.md deleted file mode 100644 index 8247817..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/templates.md +++ /dev/null @@ -1,59 +0,0 @@ -# Microsoft.ApiManagement/service/templates template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/templates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/templates", - "apiVersion": "2017-03-01", - "properties": { - "subject": "string", - "title": "string", - "description": "string", - "body": "string", - "parameters": [ - { - "name": "string", - "title": "string", - "description": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/templates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Email Template Name Identifier. - applicationApprovedNotificationMessage, accountClosedDeveloper, quotaLimitApproachingDeveloperNotificationMessage, newDeveloperNotificationMessage, emailChangeIdentityDefault, inviteUserNotificationMessage, newCommentNotificationMessage, confirmSignUpIdentityDefault, newIssueNotificationMessage, purchaseDeveloperNotificationMessage, passwordResetIdentityDefault, passwordResetByAdminNotificationMessage, rejectDeveloperNotificationMessage, requestDeveloperNotificationMessage | -| type | enum | Yes | Microsoft.ApiManagement/service/templates | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | Email Template Update contract properties. - [EmailTemplateUpdateParameterProperties object](#EmailTemplateUpdateParameterProperties) | - - - -### EmailTemplateUpdateParameterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subject | string | No | Subject of the Template. | -| title | string | No | Title of the Template. | -| description | string | No | Description of the Email Template. | -| body | string | No | Email Template Body. This should be a valid XDocument | -| parameters | array | No | Email Template Parameter values. - [EmailTemplateParametersContractProperties object](#EmailTemplateParametersContractProperties) | - - - -### EmailTemplateParametersContractProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Template parameter name. | -| title | string | No | Template parameter title. | -| description | string | No | Template parameter description. | - diff --git a/test/Resource/Expected/ApiManagement/2017-03-01/service/users.md b/test/Resource/Expected/ApiManagement/2017-03-01/service/users.md deleted file mode 100644 index 35da745..0000000 --- a/test/Resource/Expected/ApiManagement/2017-03-01/service/users.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.ApiManagement/service/users template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ApiManagement/service/users resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ApiManagement/service/users", - "apiVersion": "2017-03-01", - "properties": { - "state": "string", - "note": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "password": "string", - "confirmation": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ApiManagement/service/users object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | User identifier. Must be unique in the current API Management service instance. | -| type | enum | Yes | Microsoft.ApiManagement/service/users | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | User entity create contract properties. - [UserCreateParameterProperties object](#UserCreateParameterProperties) | - - - -### UserCreateParameterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| state | enum | No | 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. - active, blocked, pending, deleted | -| note | string | No | Optional note about a user set by the administrator. | -| email | string | Yes | Email address. Must not be empty and must be unique within the service instance. | -| firstName | string | Yes | First name. | -| lastName | string | Yes | Last name. | -| password | string | No | User Password. If no value is provided, a default password is generated. | -| confirmation | enum | No | Determines the type of confirmation e-mail that will be sent to the newly created user. - signup or invite | - diff --git a/test/Resource/Expected/Automation/2015-10-31/Microsoft.Automation.json b/test/Resource/Expected/Automation/2015-10-31/Microsoft.Automation.json deleted file mode 100644 index 7faeeb8..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/Microsoft.Automation.json +++ /dev/null @@ -1,2476 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-10-31/Microsoft.Automation.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Automation", - "description": "Microsoft Automation Resource Types", - "resourceDefinitions": { - "automationAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AutomationAccountCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets account create or update properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/automationAccounts_certificates_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_connections_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_connectionTypes_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_credentials_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_compilationjobs_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_configurations_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_nodeConfigurations_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_jobs_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_jobSchedules_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_modules_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_runbooks_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_schedules_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_variables_childResource" - }, - { - "$ref": "#/definitions/automationAccounts_webhooks_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts" - }, - "automationAccounts_certificates": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CertificateCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the certificate." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/certificates" - }, - "automationAccounts_compilationjobs": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/compilationjobs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DscCompilationJobCreateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the list of compilation job properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/compilationjobs" - }, - "automationAccounts_configurations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/configurations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DscConfigurationCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets configuration create or update properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/configurations" - }, - "automationAccounts_connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectionCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the connection." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/connections" - }, - "automationAccounts_connectionTypes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/connectionTypes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectionTypeCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the value of the connection type." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/connectionTypes" - }, - "automationAccounts_credentials": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/credentials" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CredentialCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the credential." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/credentials" - }, - "automationAccounts_jobs": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/jobs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/JobCreateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the list of job properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/jobs" - }, - "automationAccounts_jobSchedules": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/jobSchedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/JobScheduleCreateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the list of job schedule properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/jobSchedules" - }, - "automationAccounts_modules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/modules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ModuleCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the module create properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/modules" - }, - "automationAccounts_nodeConfigurations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/nodeConfigurations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "source": { - "oneOf": [ - { - "$ref": "#/definitions/ContentSource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the source." - }, - "configuration": { - "oneOf": [ - { - "$ref": "#/definitions/DscConfigurationAssociationProperty" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the configuration of the node." - }, - "newNodeConfigurationBuildVersionRequired": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If a new build version of NodeConfiguration is required." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "source", - "configuration" - ], - "description": "Microsoft.Automation/automationAccounts/nodeConfigurations" - }, - "automationAccounts_runbooks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/runbooks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RunbookCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets runbook create or update properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/runbooks" - }, - "automationAccounts_schedules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/schedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the list of schedule properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/schedules" - }, - "automationAccounts_variables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/variables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VariableCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the variable." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/variables" - }, - "automationAccounts_webhooks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/webhooks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WebhookCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the webhook." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/webhooks" - } - }, - "definitions": { - "AdvancedSchedule": { - "type": "object", - "properties": { - "weekDays": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Days of the week that the job should execute on." - }, - "monthDays": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Days of the month that the job should execute on. Must be between 1 and 31." - }, - "monthlyOccurrences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AdvancedScheduleMonthlyOccurrence" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Occurrences of days within a month." - } - }, - "description": "The properties of the create Advanced Schedule." - }, - "AdvancedScheduleMonthlyOccurrence": { - "type": "object", - "properties": { - "occurrence": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Occurrence of the week within the month. Must be between 1 and 5" - }, - "day": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday,thursday, friday, saturday, sunday." - } - }, - "description": "The properties of the create advanced schedule monthly occurrence." - }, - "AutomationAccountCreateOrUpdateProperties": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets account SKU." - } - }, - "description": "The parameters supplied to the create or update account properties." - }, - "automationAccounts_certificates_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CertificateCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the certificate." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/certificates" - }, - "automationAccounts_compilationjobs_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "compilationjobs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DscCompilationJobCreateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the list of compilation job properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/compilationjobs" - }, - "automationAccounts_configurations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "configurations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DscConfigurationCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets configuration create or update properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/configurations" - }, - "automationAccounts_connections_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectionCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the connection." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/connections" - }, - "automationAccounts_connectionTypes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "connectionTypes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectionTypeCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the value of the connection type." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/connectionTypes" - }, - "automationAccounts_credentials_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "credentials" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CredentialCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the credential." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/credentials" - }, - "automationAccounts_jobSchedules_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "jobSchedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/JobScheduleCreateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the list of job schedule properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/jobSchedules" - }, - "automationAccounts_jobs_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "jobs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/JobCreateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the list of job properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/jobs" - }, - "automationAccounts_modules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "modules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ModuleCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the module create properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/modules" - }, - "automationAccounts_nodeConfigurations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "nodeConfigurations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "source": { - "oneOf": [ - { - "$ref": "#/definitions/ContentSource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the source." - }, - "configuration": { - "oneOf": [ - { - "$ref": "#/definitions/DscConfigurationAssociationProperty" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the configuration of the node." - }, - "newNodeConfigurationBuildVersionRequired": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If a new build version of NodeConfiguration is required." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "source", - "configuration" - ], - "description": "Microsoft.Automation/automationAccounts/nodeConfigurations" - }, - "automationAccounts_runbooks_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "runbooks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RunbookCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets runbook create or update properties." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/runbooks" - }, - "automationAccounts_schedules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "schedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the list of schedule properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/schedules" - }, - "automationAccounts_variables_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "variables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VariableCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the variable." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/variables" - }, - "automationAccounts_webhooks_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "webhooks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-10-31" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WebhookCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the properties of the webhook." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/webhooks" - }, - "CertificateCreateOrUpdateProperties": { - "type": "object", - "properties": { - "base64Value": { - "type": "string", - "description": "Gets or sets the base64 encoded value of the certificate." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the certificate." - }, - "thumbprint": { - "type": "string", - "description": "Gets or sets the thumbprint of the certificate." - }, - "isExportable": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the is exportable flag of the certificate." - } - }, - "required": [ - "base64Value" - ], - "description": "The properties of the create certificate operation." - }, - "ConnectionCreateOrUpdateProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the description of the connection." - }, - "connectionType": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectionTypeAssociationProperty" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the connectionType of the connection." - }, - "fieldDefinitionValues": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the field definition properties of the connection." - } - }, - "required": [ - "connectionType" - ], - "description": "The properties of the create connection properties" - }, - "ConnectionTypeAssociationProperty": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the connection type." - } - }, - "description": "The connection type property associated with the entity." - }, - "ConnectionTypeCreateOrUpdateProperties": { - "type": "object", - "properties": { - "isGlobal": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a Boolean value to indicate if the connection type is global." - }, - "fieldDefinitions": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/FieldDefinition" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the field definitions of the connection type." - } - }, - "required": [ - "fieldDefinitions" - ], - "description": "The properties of the create connection type." - }, - "ContentHash": { - "type": "object", - "properties": { - "algorithm": { - "type": "string", - "description": "Gets or sets the content hash algorithm used to hash the content." - }, - "value": { - "type": "string", - "description": "Gets or sets expected hash value of the content." - } - }, - "required": [ - "algorithm", - "value" - ], - "description": "Definition of the runbook property type." - }, - "ContentLink": { - "type": "object", - "properties": { - "uri": { - "type": "string", - "description": "Gets or sets the uri of the runbook content." - }, - "contentHash": { - "oneOf": [ - { - "$ref": "#/definitions/ContentHash" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the hash." - }, - "version": { - "type": "string", - "description": "Gets or sets the version of the content." - } - }, - "description": "Definition of the content link." - }, - "ContentSource": { - "type": "object", - "properties": { - "hash": { - "oneOf": [ - { - "$ref": "#/definitions/ContentHash" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the hash." - }, - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "embeddedContent", - "uri" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the content source type." - }, - "value": { - "type": "string", - "description": "Gets or sets the value of the content. This is based on the content source type." - }, - "version": { - "type": "string", - "description": "Gets or sets the version of the content." - } - }, - "description": "Definition of the content source." - }, - "CredentialCreateOrUpdateProperties": { - "type": "object", - "properties": { - "userName": { - "type": "string", - "description": "Gets or sets the user name of the credential." - }, - "password": { - "type": "string", - "description": "Gets or sets the password of the credential." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the credential." - } - }, - "required": [ - "userName", - "password" - ], - "description": "The properties of the create cerdential operation." - }, - "DscCompilationJobCreateProperties": { - "type": "object", - "properties": { - "configuration": { - "oneOf": [ - { - "$ref": "#/definitions/DscConfigurationAssociationProperty" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the configuration." - }, - "parameters": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the parameters of the job." - }, - "newNodeConfigurationBuildVersionRequired": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If a new build version of NodeConfiguration is required." - } - }, - "required": [ - "configuration" - ], - "description": "The parameters supplied to the create compilation job operation." - }, - "DscConfigurationAssociationProperty": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the Dsc configuration." - } - }, - "description": "The Dsc configuration property associated with the entity." - }, - "DscConfigurationCreateOrUpdateProperties": { - "type": "object", - "properties": { - "logVerbose": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets verbose log option." - }, - "logProgress": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets progress log option." - }, - "source": { - "oneOf": [ - { - "$ref": "#/definitions/ContentSource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the source." - }, - "parameters": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/DscConfigurationParameter" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the configuration parameters." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the configuration." - } - }, - "required": [ - "source" - ], - "description": "The properties to create or update configuration." - }, - "DscConfigurationParameter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the type of the parameter." - }, - "isMandatory": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a Boolean value to indicate whether the parameter is madatory or not." - }, - "position": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Get or sets the position of the parameter." - }, - "defaultValue": { - "type": "string", - "description": "Gets or sets the default value of parameter." - } - }, - "description": "Definition of the configuration parameter type." - }, - "FieldDefinition": { - "type": "object", - "properties": { - "isEncrypted": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the isEncrypted flag of the connection field definition." - }, - "isOptional": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the isOptional flag of the connection field definition." - }, - "type": { - "type": "string", - "description": "Gets or sets the type of the connection field definition." - } - }, - "required": [ - "type" - ], - "description": "Definition of the connection fields." - }, - "JobCreateProperties": { - "type": "object", - "properties": { - "runbook": { - "oneOf": [ - { - "$ref": "#/definitions/RunbookAssociationProperty" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the runbook." - }, - "parameters": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the parameters of the job." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." - } - }, - "required": [ - "runbook" - ], - "description": "The parameters supplied to the create job operation." - }, - "JobScheduleCreateProperties": { - "type": "object", - "properties": { - "schedule": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleAssociationProperty" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the schedule." - }, - "runbook": { - "oneOf": [ - { - "$ref": "#/definitions/RunbookAssociationProperty" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the runbook." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the hybrid worker group that the scheduled job should run on." - }, - "parameters": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a list of job properties." - } - }, - "required": [ - "schedule", - "runbook" - ], - "description": "The parameters supplied to the create job schedule operation." - }, - "ModuleCreateOrUpdateProperties": { - "type": "object", - "properties": { - "contentLink": { - "oneOf": [ - { - "$ref": "#/definitions/ContentLink" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the module content link." - } - }, - "required": [ - "contentLink" - ], - "description": "The parameters supplied to the create or update module properties." - }, - "RunbookAssociationProperty": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the runbook." - } - }, - "description": "The runbook property associated with the entity." - }, - "RunbookCreateOrUpdateProperties": { - "type": "object", - "properties": { - "logVerbose": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets verbose log option." - }, - "logProgress": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets progress log option." - }, - "runbookType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Script", - "Graph", - "PowerShellWorkflow", - "PowerShell", - "GraphPowerShellWorkflow", - "GraphPowerShell" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the type of the runbook." - }, - "draft": { - "oneOf": [ - { - "$ref": "#/definitions/RunbookDraft" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the draft runbook properties." - }, - "publishContentLink": { - "oneOf": [ - { - "$ref": "#/definitions/ContentLink" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the published runbook content link." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the runbook." - }, - "logActivityTrace": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the activity-level tracing options of the runbook." - } - }, - "required": [ - "runbookType" - ], - "description": "The parameters supplied to the create or update runbook properties." - }, - "RunbookDraft": { - "type": "object", - "properties": { - "inEdit": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets whether runbook is in edit mode." - }, - "draftContentLink": { - "oneOf": [ - { - "$ref": "#/definitions/ContentLink" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the draft runbook content link." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time of the runbook draft." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time of the runbook draft." - }, - "parameters": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/RunbookParameter" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the runbook draft parameters." - }, - "outputTypes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the runbook output types." - } - }, - "description": "Definition of the runbook type." - }, - "RunbookParameter": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the type of the parameter." - }, - "isMandatory": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a Boolean value to indicate whether the parameter is madatory or not." - }, - "position": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Get or sets the position of the parameter." - }, - "defaultValue": { - "type": "string", - "description": "Gets or sets the default value of parameter." - } - }, - "description": "Definition of the runbook parameter type." - }, - "ScheduleAssociationProperty": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the schedule." - } - }, - "description": "The schedule property associated with the entity." - }, - "ScheduleCreateOrUpdateProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the description of the schedule." - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time of the schedule." - }, - "expiryTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time of the schedule." - }, - "interval": { - "type": "object", - "properties": {}, - "description": "Gets or sets the interval of the schedule." - }, - "frequency": { - "oneOf": [ - { - "type": "string", - "enum": [ - "OneTime", - "Day", - "Hour", - "Week", - "Month" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "timeZone": { - "type": "string", - "description": "Gets or sets the time zone of the schedule." - }, - "advancedSchedule": { - "oneOf": [ - { - "$ref": "#/definitions/AdvancedSchedule" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the AdvancedSchedule." - } - }, - "required": [ - "startTime", - "frequency" - ], - "description": "The parameters supplied to the create or update schedule operation." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Free", - "Basic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the SKU name of the account." - }, - "family": { - "type": "string", - "description": "Gets or sets the SKU family." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the SKU capacity." - } - }, - "required": [ - "name" - ], - "description": "The account SKU." - }, - "VariableCreateOrUpdateProperties": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Gets or sets the value of the variable." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the variable." - }, - "isEncrypted": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the encrypted flag of the variable." - } - }, - "description": "The properties of the create variable operation." - }, - "WebhookCreateOrUpdateProperties": { - "type": "object", - "properties": { - "isEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the value of the enabled flag of webhook." - }, - "uri": { - "type": "string", - "description": "Gets or sets the uri." - }, - "expiryTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the expiry time." - }, - "parameters": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the parameters of the job." - }, - "runbook": { - "oneOf": [ - { - "$ref": "#/definitions/RunbookAssociationProperty" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the runbook." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." - } - }, - "description": "The properties of the create webhook operation." - } - } -} diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts.md deleted file mode 100644 index 237e8ae..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts.md +++ /dev/null @@ -1,55 +0,0 @@ -# Microsoft.Automation/automationAccounts template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts", - "apiVersion": "2015-10-31", - "properties": { - "sku": { - "name": "string", - "family": "string", - "capacity": "integer" - } - }, - "location": "string", - "tags": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets account create or update properties. - [AutomationAccountCreateOrUpdateProperties object](#AutomationAccountCreateOrUpdateProperties) | -| location | string | No | Gets or sets the location of the resource. | -| tags | object | No | Gets or sets the tags attached to the resource. | -| resources | array | No | [webhooks](./automationAccounts/webhooks.md) [variables](./automationAccounts/variables.md) [schedules](./automationAccounts/schedules.md) [runbooks](./automationAccounts/runbooks.md) [modules](./automationAccounts/modules.md) [jobSchedules](./automationAccounts/jobSchedules.md) [jobs](./automationAccounts/jobs.md) [nodeConfigurations](./automationAccounts/nodeConfigurations.md) [configurations](./automationAccounts/configurations.md) [compilationjobs](./automationAccounts/compilationjobs.md) [credentials](./automationAccounts/credentials.md) [connectionTypes](./automationAccounts/connectionTypes.md) [connections](./automationAccounts/connections.md) [certificates](./automationAccounts/certificates.md) | - - - -### AutomationAccountCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | Gets or sets account SKU. - [Sku object](#Sku) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Gets or sets the SKU name of the account. - Free or Basic | -| family | string | No | Gets or sets the SKU family. | -| capacity | integer | No | Gets or sets the SKU capacity. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/certificates.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/certificates.md deleted file mode 100644 index d61b3c5..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/certificates.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.Automation/automationAccounts/certificates template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/certificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/certificates", - "apiVersion": "2015-10-31", - "properties": { - "base64Value": "string", - "description": "string", - "thumbprint": "string", - "isExportable": "boolean" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/certificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/certificates | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the properties of the certificate. - [CertificateCreateOrUpdateProperties object](#CertificateCreateOrUpdateProperties) | - - - -### CertificateCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| base64Value | string | Yes | Gets or sets the base64 encoded value of the certificate. | -| description | string | No | Gets or sets the description of the certificate. | -| thumbprint | string | No | Gets or sets the thumbprint of the certificate. | -| isExportable | boolean | No | Gets or sets the is exportable flag of the certificate. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/compilationjobs.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/compilationjobs.md deleted file mode 100644 index 58cbb1e..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/compilationjobs.md +++ /dev/null @@ -1,53 +0,0 @@ -# Microsoft.Automation/automationAccounts/compilationjobs template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/compilationjobs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/compilationjobs", - "apiVersion": "2015-10-31", - "properties": { - "configuration": { - "name": "string" - }, - "parameters": {}, - "newNodeConfigurationBuildVersionRequired": "boolean" - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/compilationjobs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | globally unique identifier | -| type | enum | Yes | Microsoft.Automation/automationAccounts/compilationjobs | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the list of compilation job properties. - [DscCompilationJobCreateProperties object](#DscCompilationJobCreateProperties) | -| location | string | No | Gets or sets the location of the resource. | -| tags | object | No | Gets or sets the tags attached to the resource. | - - - -### DscCompilationJobCreateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| configuration | object | Yes | Gets or sets the configuration. - [DscConfigurationAssociationProperty object](#DscConfigurationAssociationProperty) | -| parameters | object | No | Gets or sets the parameters of the job. | -| newNodeConfigurationBuildVersionRequired | boolean | No | If a new build version of NodeConfiguration is required. | - - - -### DscConfigurationAssociationProperty object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets or sets the name of the Dsc configuration. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/configurations.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/configurations.md deleted file mode 100644 index a6d6b2a..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/configurations.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Automation/automationAccounts/configurations template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/configurations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/configurations", - "apiVersion": "2015-10-31", - "properties": { - "logVerbose": "boolean", - "logProgress": "boolean", - "source": { - "hash": { - "algorithm": "string", - "value": "string" - }, - "type": "string", - "value": "string", - "version": "string" - }, - "parameters": {}, - "description": "string" - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/configurations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/configurations | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets configuration create or update properties. - [DscConfigurationCreateOrUpdateProperties object](#DscConfigurationCreateOrUpdateProperties) | -| location | string | No | Gets or sets the location of the resource. | -| tags | object | No | Gets or sets the tags attached to the resource. | - - - -### DscConfigurationCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| logVerbose | boolean | No | Gets or sets verbose log option. | -| logProgress | boolean | No | Gets or sets progress log option. | -| source | object | Yes | Gets or sets the source. - [ContentSource object](#ContentSource) | -| parameters | object | No | Gets or sets the configuration parameters. | -| description | string | No | Gets or sets the description of the configuration. | - - - -### ContentSource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| hash | object | No | Gets or sets the hash. - [ContentHash object](#ContentHash) | -| type | enum | No | Gets or sets the content source type. - embeddedContent or uri | -| value | string | No | Gets or sets the value of the content. This is based on the content source type. | -| version | string | No | Gets or sets the version of the content. | - - - -### ContentHash object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| algorithm | string | Yes | Gets or sets the content hash algorithm used to hash the content. | -| value | string | Yes | Gets or sets expected hash value of the content. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/connectionTypes.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/connectionTypes.md deleted file mode 100644 index 8a1c546..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/connectionTypes.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.Automation/automationAccounts/connectionTypes template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/connectionTypes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/connectionTypes", - "apiVersion": "2015-10-31", - "properties": { - "isGlobal": "boolean", - "fieldDefinitions": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/connectionTypes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/connectionTypes | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the value of the connection type. - [ConnectionTypeCreateOrUpdateProperties object](#ConnectionTypeCreateOrUpdateProperties) | - - - -### ConnectionTypeCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| isGlobal | boolean | No | Gets or sets a Boolean value to indicate if the connection type is global. | -| fieldDefinitions | object | Yes | Gets or sets the field definitions of the connection type. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/connections.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/connections.md deleted file mode 100644 index 425e7fa..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/connections.md +++ /dev/null @@ -1,49 +0,0 @@ -# Microsoft.Automation/automationAccounts/connections template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/connections", - "apiVersion": "2015-10-31", - "properties": { - "description": "string", - "connectionType": { - "name": "string" - }, - "fieldDefinitionValues": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/connections | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the properties of the connection. - [ConnectionCreateOrUpdateProperties object](#ConnectionCreateOrUpdateProperties) | - - - -### ConnectionCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets the description of the connection. | -| connectionType | object | Yes | Gets or sets the connectionType of the connection. - [ConnectionTypeAssociationProperty object](#ConnectionTypeAssociationProperty) | -| fieldDefinitionValues | object | No | Gets or sets the field definition properties of the connection. | - - - -### ConnectionTypeAssociationProperty object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets or sets the name of the connection type. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/credentials.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/credentials.md deleted file mode 100644 index e450734..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/credentials.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Automation/automationAccounts/credentials template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/credentials resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/credentials", - "apiVersion": "2015-10-31", - "properties": { - "userName": "string", - "password": "string", - "description": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/credentials object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/credentials | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the properties of the credential. - [CredentialCreateOrUpdateProperties object](#CredentialCreateOrUpdateProperties) | - - - -### CredentialCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| userName | string | Yes | Gets or sets the user name of the credential. | -| password | string | Yes | Gets or sets the password of the credential. | -| description | string | No | Gets or sets the description of the credential. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/jobSchedules.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/jobSchedules.md deleted file mode 100644 index 9ac1164..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/jobSchedules.md +++ /dev/null @@ -1,60 +0,0 @@ -# Microsoft.Automation/automationAccounts/jobSchedules template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/jobSchedules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/jobSchedules", - "apiVersion": "2015-10-31", - "properties": { - "schedule": { - "name": "string" - }, - "runbook": { - "name": "string" - }, - "runOn": "string", - "parameters": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/jobSchedules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | globally unique identifier | -| type | enum | Yes | Microsoft.Automation/automationAccounts/jobSchedules | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the list of job schedule properties. - [JobScheduleCreateProperties object](#JobScheduleCreateProperties) | - - - -### JobScheduleCreateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| schedule | object | Yes | Gets or sets the schedule. - [ScheduleAssociationProperty object](#ScheduleAssociationProperty) | -| runbook | object | Yes | Gets or sets the runbook. - [RunbookAssociationProperty object](#RunbookAssociationProperty) | -| runOn | string | No | Gets or sets the hybrid worker group that the scheduled job should run on. | -| parameters | object | No | Gets or sets a list of job properties. | - - - -### ScheduleAssociationProperty object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets or sets the name of the schedule. | - - - -### RunbookAssociationProperty object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets or sets the name of the runbook. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/jobs.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/jobs.md deleted file mode 100644 index d4b2290..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/jobs.md +++ /dev/null @@ -1,53 +0,0 @@ -# Microsoft.Automation/automationAccounts/jobs template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/jobs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/jobs", - "apiVersion": "2015-10-31", - "properties": { - "runbook": { - "name": "string" - }, - "parameters": {}, - "runOn": "string" - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/jobs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | globally unique identifier | -| type | enum | Yes | Microsoft.Automation/automationAccounts/jobs | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the list of job properties. - [JobCreateProperties object](#JobCreateProperties) | -| location | string | No | Gets or sets the location of the resource. | -| tags | object | No | Gets or sets the tags attached to the resource. | - - - -### JobCreateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| runbook | object | Yes | Gets or sets the runbook. - [RunbookAssociationProperty object](#RunbookAssociationProperty) | -| parameters | object | No | Gets or sets the parameters of the job. | -| runOn | string | No | Gets or sets the runOn which specifies the group name where the job is to be executed. | - - - -### RunbookAssociationProperty object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets or sets the name of the runbook. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/modules.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/modules.md deleted file mode 100644 index d42f69c..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/modules.md +++ /dev/null @@ -1,64 +0,0 @@ -# Microsoft.Automation/automationAccounts/modules template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/modules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/modules", - "apiVersion": "2015-10-31", - "properties": { - "contentLink": { - "uri": "string", - "contentHash": { - "algorithm": "string", - "value": "string" - }, - "version": "string" - } - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/modules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/modules | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the module create properties. - [ModuleCreateOrUpdateProperties object](#ModuleCreateOrUpdateProperties) | -| location | string | No | Gets or sets the location of the resource. | -| tags | object | No | Gets or sets the tags attached to the resource. | - - - -### ModuleCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| contentLink | object | Yes | Gets or sets the module content link. - [ContentLink object](#ContentLink) | - - - -### ContentLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Gets or sets the uri of the runbook content. | -| contentHash | object | No | Gets or sets the hash. - [ContentHash object](#ContentHash) | -| version | string | No | Gets or sets the version of the content. | - - - -### ContentHash object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| algorithm | string | Yes | Gets or sets the content hash algorithm used to hash the content. | -| value | string | Yes | Gets or sets expected hash value of the content. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/nodeConfigurations.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/nodeConfigurations.md deleted file mode 100644 index b79fd1f..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/nodeConfigurations.md +++ /dev/null @@ -1,66 +0,0 @@ -# Microsoft.Automation/automationAccounts/nodeConfigurations template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/nodeConfigurations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/nodeConfigurations", - "apiVersion": "2015-10-31", - "source": { - "hash": { - "algorithm": "string", - "value": "string" - }, - "type": "string", - "value": "string", - "version": "string" - }, - "configuration": { - "name": "string" - }, - "newNodeConfigurationBuildVersionRequired": "boolean" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/nodeConfigurations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/nodeConfigurations | -| apiVersion | enum | Yes | 2015-10-31 | -| source | object | Yes | Gets or sets the source. - [ContentSource object](#ContentSource) | -| configuration | object | Yes | Gets or sets the configuration of the node. - [DscConfigurationAssociationProperty object](#DscConfigurationAssociationProperty) | -| newNodeConfigurationBuildVersionRequired | boolean | No | If a new build version of NodeConfiguration is required. | - - - -### ContentSource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| hash | object | No | Gets or sets the hash. - [ContentHash object](#ContentHash) | -| type | enum | No | Gets or sets the content source type. - embeddedContent or uri | -| value | string | No | Gets or sets the value of the content. This is based on the content source type. | -| version | string | No | Gets or sets the version of the content. | - - - -### DscConfigurationAssociationProperty object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets or sets the name of the Dsc configuration. | - - - -### ContentHash object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| algorithm | string | Yes | Gets or sets the content hash algorithm used to hash the content. | -| value | string | Yes | Gets or sets expected hash value of the content. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/runbooks.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/runbooks.md deleted file mode 100644 index b00766f..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/runbooks.md +++ /dev/null @@ -1,104 +0,0 @@ -# Microsoft.Automation/automationAccounts/runbooks template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/runbooks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/runbooks", - "apiVersion": "2015-10-31", - "properties": { - "logVerbose": "boolean", - "logProgress": "boolean", - "runbookType": "string", - "draft": { - "inEdit": "boolean", - "draftContentLink": { - "uri": "string", - "contentHash": { - "algorithm": "string", - "value": "string" - }, - "version": "string" - }, - "creationTime": "string", - "lastModifiedTime": "string", - "parameters": {}, - "outputTypes": [ - "string" - ] - }, - "publishContentLink": { - "uri": "string", - "contentHash": { - "algorithm": "string", - "value": "string" - }, - "version": "string" - }, - "description": "string", - "logActivityTrace": "integer" - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/runbooks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/runbooks | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets runbook create or update properties. - [RunbookCreateOrUpdateProperties object](#RunbookCreateOrUpdateProperties) | -| location | string | No | Gets or sets the location of the resource. | -| tags | object | No | Gets or sets the tags attached to the resource. | - - - -### RunbookCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| logVerbose | boolean | No | Gets or sets verbose log option. | -| logProgress | boolean | No | Gets or sets progress log option. | -| runbookType | enum | Yes | Gets or sets the type of the runbook. - Script, Graph, PowerShellWorkflow, PowerShell, GraphPowerShellWorkflow, GraphPowerShell | -| draft | object | No | Gets or sets the draft runbook properties. - [RunbookDraft object](#RunbookDraft) | -| publishContentLink | object | No | Gets or sets the published runbook content link. - [ContentLink object](#ContentLink) | -| description | string | No | Gets or sets the description of the runbook. | -| logActivityTrace | integer | No | Gets or sets the activity-level tracing options of the runbook. | - - - -### RunbookDraft object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| inEdit | boolean | No | Gets or sets whether runbook is in edit mode. | -| draftContentLink | object | No | Gets or sets the draft runbook content link. - [ContentLink object](#ContentLink) | -| creationTime | string | No | Gets or sets the creation time of the runbook draft. | -| lastModifiedTime | string | No | Gets or sets the last modified time of the runbook draft. | -| parameters | object | No | Gets or sets the runbook draft parameters. | -| outputTypes | array | No | Gets or sets the runbook output types. - string | - - - -### ContentLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Gets or sets the uri of the runbook content. | -| contentHash | object | No | Gets or sets the hash. - [ContentHash object](#ContentHash) | -| version | string | No | Gets or sets the version of the content. | - - - -### ContentHash object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| algorithm | string | Yes | Gets or sets the content hash algorithm used to hash the content. | -| value | string | Yes | Gets or sets expected hash value of the content. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/schedules.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/schedules.md deleted file mode 100644 index 9968c6c..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/schedules.md +++ /dev/null @@ -1,78 +0,0 @@ -# Microsoft.Automation/automationAccounts/schedules template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/schedules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/schedules", - "apiVersion": "2015-10-31", - "properties": { - "description": "string", - "startTime": "string", - "expiryTime": "string", - "interval": {}, - "frequency": "string", - "timeZone": "string", - "advancedSchedule": { - "weekDays": [ - "string" - ], - "monthDays": [ - "integer" - ], - "monthlyOccurrences": [ - { - "occurrence": "integer", - "day": "string" - } - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/schedules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/schedules | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the list of schedule properties. - [ScheduleCreateOrUpdateProperties object](#ScheduleCreateOrUpdateProperties) | - - - -### ScheduleCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets the description of the schedule. | -| startTime | string | Yes | Gets or sets the start time of the schedule. | -| expiryTime | string | No | Gets or sets the end time of the schedule. | -| interval | object | No | Gets or sets the interval of the schedule. | -| frequency | enum | Yes | OneTime, Day, Hour, Week, Month | -| timeZone | string | No | Gets or sets the time zone of the schedule. | -| advancedSchedule | object | No | Gets or sets the AdvancedSchedule. - [AdvancedSchedule object](#AdvancedSchedule) | - - - -### AdvancedSchedule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| weekDays | array | No | Days of the week that the job should execute on. - string | -| monthDays | array | No | Days of the month that the job should execute on. Must be between 1 and 31. - integer | -| monthlyOccurrences | array | No | Occurrences of days within a month. - [AdvancedScheduleMonthlyOccurrence object](#AdvancedScheduleMonthlyOccurrence) | - - - -### AdvancedScheduleMonthlyOccurrence object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| occurrence | integer | No | Occurrence of the week within the month. Must be between 1 and 5 | -| day | enum | No | Day of the occurrence. Must be one of monday, tuesday, wednesday,thursday, friday, saturday, sunday. - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/variables.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/variables.md deleted file mode 100644 index f1b7420..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/variables.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Automation/automationAccounts/variables template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/variables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/variables", - "apiVersion": "2015-10-31", - "properties": { - "value": "string", - "description": "string", - "isEncrypted": "boolean" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/variables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/variables | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the properties of the variable. - [VariableCreateOrUpdateProperties object](#VariableCreateOrUpdateProperties) | - - - -### VariableCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | string | No | Gets or sets the value of the variable. | -| description | string | No | Gets or sets the description of the variable. | -| isEncrypted | boolean | No | Gets or sets the encrypted flag of the variable. | - diff --git a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/webhooks.md b/test/Resource/Expected/Automation/2015-10-31/automationAccounts/webhooks.md deleted file mode 100644 index 2333cbf..0000000 --- a/test/Resource/Expected/Automation/2015-10-31/automationAccounts/webhooks.md +++ /dev/null @@ -1,55 +0,0 @@ -# Microsoft.Automation/automationAccounts/webhooks template reference -API Version: 2015-10-31 -## Template format - -To create a Microsoft.Automation/automationAccounts/webhooks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/webhooks", - "apiVersion": "2015-10-31", - "properties": { - "isEnabled": "boolean", - "uri": "string", - "expiryTime": "string", - "parameters": {}, - "runbook": { - "name": "string" - }, - "runOn": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/webhooks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/webhooks | -| apiVersion | enum | Yes | 2015-10-31 | -| properties | object | Yes | Gets or sets the properties of the webhook. - [WebhookCreateOrUpdateProperties object](#WebhookCreateOrUpdateProperties) | - - - -### WebhookCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| isEnabled | boolean | No | Gets or sets the value of the enabled flag of webhook. | -| uri | string | No | Gets or sets the uri. | -| expiryTime | string | No | Gets or sets the expiry time. | -| parameters | object | No | Gets or sets the parameters of the job. | -| runbook | object | No | Gets or sets the runbook. - [RunbookAssociationProperty object](#RunbookAssociationProperty) | -| runOn | string | No | Gets or sets the name of the hybrid worker group the webhook job will run on. | - - - -### RunbookAssociationProperty object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets or sets the name of the runbook. | - diff --git a/test/Resource/Expected/Automation/2017-05-15-preview/Microsoft.Automation.json b/test/Resource/Expected/Automation/2017-05-15-preview/Microsoft.Automation.json deleted file mode 100644 index 60aadc0..0000000 --- a/test/Resource/Expected/Automation/2017-05-15-preview/Microsoft.Automation.json +++ /dev/null @@ -1,455 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-05-15-preview/Microsoft.Automation.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Automation", - "description": "Microsoft Automation Resource Types", - "resourceDefinitions": { - "automationAccounts_softwareUpdateConfigurations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Automation/automationAccounts/softwareUpdateConfigurations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-05-15-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SoftwareUpdateConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Software update configuration properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Automation/automationAccounts/softwareUpdateConfigurations" - } - }, - "definitions": { - "AdvancedSchedule": { - "type": "object", - "properties": { - "weekDays": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Days of the week that the job should execute on." - }, - "monthDays": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Days of the month that the job should execute on. Must be between 1 and 31." - }, - "monthlyOccurrences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AdvancedScheduleMonthlyOccurrence" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Occurrences of days within a month." - } - }, - "description": "The properties of the create Advanced Schedule." - }, - "AdvancedScheduleMonthlyOccurrence": { - "type": "object", - "properties": { - "occurrence": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Occurrence of the week within the month. Must be between 1 and 5" - }, - "day": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday,thursday, friday, saturday, sunday." - } - }, - "description": "The properties of the create advanced schedule monthly occurrence." - }, - "ErrorResponse": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error code" - }, - "message": { - "type": "string", - "description": "Error message indicating why the operation failed." - } - }, - "description": "Error response of an operation failure" - }, - "LinuxProperties": { - "type": "object", - "properties": { - "includedPackageClassifications": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Unclassified", - "Critical", - "Security", - "Other" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Update classifications included in the software update configuration." - }, - "excludedPackageNameMasks": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "packages excluded from the software update configuration." - } - }, - "description": "Linux specific update configuration." - }, - "ScheduleProperties": { - "type": "object", - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time of the schedule." - }, - "expiryTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time of the schedule." - }, - "expiryTimeOffsetMinutes": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the expiry time's offset in minutes." - }, - "isEnabled": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a value indicating whether this schedule is enabled." - }, - "nextRun": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the next run time of the schedule." - }, - "nextRunOffsetMinutes": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the next run time's offset in minutes." - }, - "interval": { - "type": "object", - "properties": {}, - "description": "Gets or sets the interval of the schedule." - }, - "frequency": { - "oneOf": [ - { - "type": "string", - "enum": [ - "OneTime", - "Day", - "Hour", - "Week", - "Month" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the frequency of the schedule." - }, - "timeZone": { - "type": "string", - "description": "Gets or sets the time zone of the schedule." - }, - "advancedSchedule": { - "oneOf": [ - { - "$ref": "#/definitions/AdvancedSchedule" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the advanced schedule." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time." - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of schedule parameters." - }, - "SoftwareUpdateConfigurationProperties": { - "type": "object", - "properties": { - "updateConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/UpdateConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "update specific properties for the Software update configuration" - }, - "scheduleInfo": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Schedule information for the Software update configuration" - }, - "error": { - "oneOf": [ - { - "$ref": "#/definitions/ErrorResponse" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "detailes of provisioning error" - } - }, - "required": [ - "updateConfiguration", - "scheduleInfo" - ], - "description": "Software update configuration properties." - }, - "UpdateConfiguration": { - "type": "object", - "properties": { - "operatingSystem": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "operating system of target machines." - }, - "windows": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Windows specific update configuration." - }, - "linux": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Linux specific update configuration." - }, - "duration": { - "type": "string", - "format": "duration", - "description": "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" - }, - "azureVirtualMachines": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of azure resource Ids for azure virtual machines targeted by the software update configuration." - }, - "nonAzureComputerNames": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of names of non-azure machines targeted by the software update configuration." - } - }, - "required": [ - "operatingSystem" - ], - "description": "Update specifc properties of the software update configuration." - }, - "WindowsProperties": { - "type": "object", - "properties": { - "includedUpdateClassifications": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Unclassified", - "Critical", - "Security", - "UpdateRollup", - "FeaturePack", - "ServicePack", - "Definition", - "Tools", - "Updates" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Update classification included in the software update configuration. A comma separated string with required values." - }, - "excludedKbNumbers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "KB numbers excluded from the software update configuration." - } - }, - "description": "Windows specific update configuration." - } - } -} diff --git a/test/Resource/Expected/Automation/2017-05-15-preview/automationAccounts/softwareUpdateConfigurations.md b/test/Resource/Expected/Automation/2017-05-15-preview/automationAccounts/softwareUpdateConfigurations.md deleted file mode 100644 index bd434d9..0000000 --- a/test/Resource/Expected/Automation/2017-05-15-preview/automationAccounts/softwareUpdateConfigurations.md +++ /dev/null @@ -1,163 +0,0 @@ -# Microsoft.Automation/automationAccounts/softwareUpdateConfigurations template reference -API Version: 2017-05-15-preview -## Template format - -To create a Microsoft.Automation/automationAccounts/softwareUpdateConfigurations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Automation/automationAccounts/softwareUpdateConfigurations", - "apiVersion": "2017-05-15-preview", - "properties": { - "updateConfiguration": { - "operatingSystem": "string", - "windows": { - "includedUpdateClassifications": "string", - "excludedKbNumbers": [ - "string" - ] - }, - "linux": { - "includedPackageClassifications": "string", - "excludedPackageNameMasks": [ - "string" - ] - }, - "duration": "string", - "azureVirtualMachines": [ - "string" - ], - "nonAzureComputerNames": [ - "string" - ] - }, - "scheduleInfo": { - "startTime": "string", - "expiryTime": "string", - "expiryTimeOffsetMinutes": "number", - "isEnabled": "boolean", - "nextRun": "string", - "nextRunOffsetMinutes": "number", - "interval": {}, - "frequency": "string", - "timeZone": "string", - "advancedSchedule": { - "weekDays": [ - "string" - ], - "monthDays": [ - "integer" - ], - "monthlyOccurrences": [ - { - "occurrence": "integer", - "day": "string" - } - ] - }, - "creationTime": "string", - "lastModifiedTime": "string", - "description": "string" - }, - "error": { - "code": "string", - "message": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Automation/automationAccounts/softwareUpdateConfigurations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Automation/automationAccounts/softwareUpdateConfigurations | -| apiVersion | enum | Yes | 2017-05-15-preview | -| properties | object | Yes | Software update configuration properties. - [SoftwareUpdateConfigurationProperties object](#SoftwareUpdateConfigurationProperties) | - - - -### SoftwareUpdateConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| updateConfiguration | object | Yes | update specific properties for the Software update configuration - [UpdateConfiguration object](#UpdateConfiguration) | -| scheduleInfo | object | Yes | Schedule information for the Software update configuration - [ScheduleProperties object](#ScheduleProperties) | -| error | object | No | detailes of provisioning error - [ErrorResponse object](#ErrorResponse) | - - - -### UpdateConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| operatingSystem | enum | Yes | operating system of target machines. - Windows or Linux | -| windows | object | No | Windows specific update configuration. - [WindowsProperties object](#WindowsProperties) | -| linux | object | No | Linux specific update configuration. - [LinuxProperties object](#LinuxProperties) | -| duration | string | No | 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 | -| azureVirtualMachines | array | No | List of azure resource Ids for azure virtual machines targeted by the software update configuration. - string | -| nonAzureComputerNames | array | No | List of names of non-azure machines targeted by the software update configuration. - string | - - - -### ScheduleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| startTime | string | No | Gets or sets the start time of the schedule. | -| expiryTime | string | No | Gets or sets the end time of the schedule. | -| expiryTimeOffsetMinutes | number | No | Gets or sets the expiry time's offset in minutes. | -| isEnabled | boolean | No | Gets or sets a value indicating whether this schedule is enabled. | -| nextRun | string | No | Gets or sets the next run time of the schedule. | -| nextRunOffsetMinutes | number | No | Gets or sets the next run time's offset in minutes. | -| interval | object | No | Gets or sets the interval of the schedule. | -| frequency | enum | No | Gets or sets the frequency of the schedule. - OneTime, Day, Hour, Week, Month | -| timeZone | string | No | Gets or sets the time zone of the schedule. | -| advancedSchedule | object | No | Gets or sets the advanced schedule. - [AdvancedSchedule object](#AdvancedSchedule) | -| creationTime | string | No | Gets or sets the creation time. | -| lastModifiedTime | string | No | Gets or sets the last modified time. | -| description | string | No | Gets or sets the description. | - - - -### ErrorResponse object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| code | string | No | Error code | -| message | string | No | Error message indicating why the operation failed. | - - - -### WindowsProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| includedUpdateClassifications | enum | No | Update classification included in the software update configuration. A comma separated string with required values. - Unclassified, Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates | -| excludedKbNumbers | array | No | KB numbers excluded from the software update configuration. - string | - - - -### LinuxProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| includedPackageClassifications | enum | No | Update classifications included in the software update configuration. - Unclassified, Critical, Security, Other | -| excludedPackageNameMasks | array | No | packages excluded from the software update configuration. - string | - - - -### AdvancedSchedule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| weekDays | array | No | Days of the week that the job should execute on. - string | -| monthDays | array | No | Days of the month that the job should execute on. Must be between 1 and 31. - integer | -| monthlyOccurrences | array | No | Occurrences of days within a month. - [AdvancedScheduleMonthlyOccurrence object](#AdvancedScheduleMonthlyOccurrence) | - - - -### AdvancedScheduleMonthlyOccurrence object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| occurrence | integer | No | Occurrence of the week within the month. Must be between 1 and 5 | -| day | enum | No | Day of the occurrence. Must be one of monday, tuesday, wednesday,thursday, friday, saturday, sunday. - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday | - diff --git a/test/Resource/Expected/Batch/2015-12-01/Microsoft.Batch.json b/test/Resource/Expected/Batch/2015-12-01/Microsoft.Batch.json deleted file mode 100644 index 4339e13..0000000 --- a/test/Resource/Expected/Batch/2015-12-01/Microsoft.Batch.json +++ /dev/null @@ -1,252 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-12-01/Microsoft.Batch.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Batch", - "description": "Microsoft Batch Resource Types", - "resourceDefinitions": { - "batchAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-12-01" - ] - }, - "location": { - "type": "string", - "description": "The region in which to create the account." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The user specified tags associated with the account." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BatchAccountBaseProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the account." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/batchAccounts_applications_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Batch/batchAccounts" - }, - "batchAccounts_applications": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/applications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-12-01" - ] - }, - "allowUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A value indicating whether packages within the application may be overwritten using the same version string." - }, - "displayName": { - "type": "string", - "description": "The display name for the application." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/batchAccounts_applications_versions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications" - }, - "batchAccounts_applications_versions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/applications/versions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-12-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications/versions" - } - }, - "definitions": { - "AutoStorageBaseProperties": { - "type": "object", - "properties": { - "storageAccountId": { - "type": "string", - "description": "The resource ID of the storage account to be used for auto storage account." - } - }, - "required": [ - "storageAccountId" - ], - "description": "The properties related to auto storage account." - }, - "BatchAccountBaseProperties": { - "type": "object", - "properties": { - "autoStorage": { - "oneOf": [ - { - "$ref": "#/definitions/AutoStorageBaseProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties related to auto storage account." - } - }, - "description": "The properties of a Batch account." - }, - "batchAccounts_applications_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "applications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-12-01" - ] - }, - "allowUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A value indicating whether packages within the application may be overwritten using the same version string." - }, - "displayName": { - "type": "string", - "description": "The display name for the application." - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications" - }, - "batchAccounts_applications_versions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "versions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-12-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications/versions" - } - } -} diff --git a/test/Resource/Expected/Batch/2015-12-01/batchAccounts.md b/test/Resource/Expected/Batch/2015-12-01/batchAccounts.md deleted file mode 100644 index d806a31..0000000 --- a/test/Resource/Expected/Batch/2015-12-01/batchAccounts.md +++ /dev/null @@ -1,51 +0,0 @@ -# Microsoft.Batch/batchAccounts template reference -API Version: 2015-12-01 -## Template format - -To create a Microsoft.Batch/batchAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts", - "apiVersion": "2015-12-01", - "location": "string", - "tags": {}, - "properties": { - "autoStorage": { - "storageAccountId": "string" - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts | -| apiVersion | enum | Yes | 2015-12-01 | -| location | string | Yes | The region in which to create the account. | -| tags | object | No | The user specified tags associated with the account. | -| properties | object | Yes | The properties of the account. - [BatchAccountBaseProperties object](#BatchAccountBaseProperties) | -| resources | array | No | [applications](./batchAccounts/applications.md) | - - - -### BatchAccountBaseProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| autoStorage | object | No | The properties related to auto storage account. - [AutoStorageBaseProperties object](#AutoStorageBaseProperties) | - - - -### AutoStorageBaseProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountId | string | Yes | The resource ID of the storage account to be used for auto storage account. | - diff --git a/test/Resource/Expected/Batch/2015-12-01/batchAccounts/applications.md b/test/Resource/Expected/Batch/2015-12-01/batchAccounts/applications.md deleted file mode 100644 index 07fdf83..0000000 --- a/test/Resource/Expected/Batch/2015-12-01/batchAccounts/applications.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.Batch/batchAccounts/applications template reference -API Version: 2015-12-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/applications resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/applications", - "apiVersion": "2015-12-01", - "allowUpdates": "boolean", - "displayName": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/applications object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts/applications | -| apiVersion | enum | Yes | 2015-12-01 | -| allowUpdates | boolean | No | A value indicating whether packages within the application may be overwritten using the same version string. | -| displayName | string | No | The display name for the application. | -| resources | array | No | [versions](./applications/versions.md) | - diff --git a/test/Resource/Expected/Batch/2015-12-01/batchAccounts/applications/versions.md b/test/Resource/Expected/Batch/2015-12-01/batchAccounts/applications/versions.md deleted file mode 100644 index 8ba6ca8..0000000 --- a/test/Resource/Expected/Batch/2015-12-01/batchAccounts/applications/versions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.Batch/batchAccounts/applications/versions template reference -API Version: 2015-12-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/applications/versions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/applications/versions", - "apiVersion": "2015-12-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/applications/versions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts/applications/versions | -| apiVersion | enum | Yes | 2015-12-01 | - diff --git a/test/Resource/Expected/Batch/2017-01-01/Microsoft.Batch.json b/test/Resource/Expected/Batch/2017-01-01/Microsoft.Batch.json deleted file mode 100644 index d05e7ac..0000000 --- a/test/Resource/Expected/Batch/2017-01-01/Microsoft.Batch.json +++ /dev/null @@ -1,296 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-01-01/Microsoft.Batch.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Batch", - "description": "Microsoft Batch Resource Types", - "resourceDefinitions": { - "batchAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "location": { - "type": "string", - "description": "The region in which to create the account." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The user specified tags associated with the account." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BatchAccountBaseProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the Batch account." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/batchAccounts_applications_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Batch/batchAccounts" - }, - "batchAccounts_applications": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/applications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "allowUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A value indicating whether packages within the application may be overwritten using the same version string." - }, - "displayName": { - "type": "string", - "description": "The display name for the application." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/batchAccounts_applications_versions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications" - }, - "batchAccounts_applications_versions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/applications/versions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications/versions" - } - }, - "definitions": { - "AutoStorageBaseProperties": { - "type": "object", - "properties": { - "storageAccountId": { - "type": "string", - "description": "The resource ID of the storage account to be used for auto storage account." - } - }, - "required": [ - "storageAccountId" - ], - "description": "The properties related to auto storage account." - }, - "BatchAccountBaseProperties": { - "type": "object", - "properties": { - "autoStorage": { - "oneOf": [ - { - "$ref": "#/definitions/AutoStorageBaseProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties related to auto storage account." - }, - "poolAllocationMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "BatchService", - "UserSubscription" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService." - }, - "keyVaultReference": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to the Azure key vault associated with the Batch account." - } - }, - "description": "The properties of a Batch account." - }, - "batchAccounts_applications_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "applications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "allowUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A value indicating whether packages within the application may be overwritten using the same version string." - }, - "displayName": { - "type": "string", - "description": "The display name for the application." - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications" - }, - "batchAccounts_applications_versions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "versions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications/versions" - }, - "KeyVaultReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The resource ID of the Azure key vault associated with the Batch account." - }, - "url": { - "type": "string", - "description": "The Url of the Azure key vault associated with the Batch account." - } - }, - "required": [ - "id", - "url" - ], - "description": "Identifies the Azure key vault associated with a Batch account." - } - } -} diff --git a/test/Resource/Expected/Batch/2017-01-01/batchAccounts.md b/test/Resource/Expected/Batch/2017-01-01/batchAccounts.md deleted file mode 100644 index 992b53c..0000000 --- a/test/Resource/Expected/Batch/2017-01-01/batchAccounts.md +++ /dev/null @@ -1,66 +0,0 @@ -# Microsoft.Batch/batchAccounts template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.Batch/batchAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts", - "apiVersion": "2017-01-01", - "location": "string", - "tags": {}, - "properties": { - "autoStorage": { - "storageAccountId": "string" - }, - "poolAllocationMode": "string", - "keyVaultReference": { - "id": "string", - "url": "string" - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts | -| apiVersion | enum | Yes | 2017-01-01 | -| location | string | Yes | The region in which to create the account. | -| tags | object | No | The user specified tags associated with the account. | -| properties | object | Yes | The properties of the Batch account. - [BatchAccountBaseProperties object](#BatchAccountBaseProperties) | -| resources | array | No | [applications](./batchAccounts/applications.md) | - - - -### BatchAccountBaseProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| autoStorage | object | No | The properties related to auto storage account. - [AutoStorageBaseProperties object](#AutoStorageBaseProperties) | -| poolAllocationMode | enum | No | The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. - BatchService or UserSubscription | -| keyVaultReference | object | No | A reference to the Azure key vault associated with the Batch account. - [KeyVaultReference object](#KeyVaultReference) | - - - -### AutoStorageBaseProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountId | string | Yes | The resource ID of the storage account to be used for auto storage account. | - - - -### KeyVaultReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | The resource ID of the Azure key vault associated with the Batch account. | -| url | string | Yes | The Url of the Azure key vault associated with the Batch account. | - diff --git a/test/Resource/Expected/Batch/2017-01-01/batchAccounts/applications.md b/test/Resource/Expected/Batch/2017-01-01/batchAccounts/applications.md deleted file mode 100644 index 2640baa..0000000 --- a/test/Resource/Expected/Batch/2017-01-01/batchAccounts/applications.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.Batch/batchAccounts/applications template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/applications resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/applications", - "apiVersion": "2017-01-01", - "allowUpdates": "boolean", - "displayName": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/applications object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts/applications | -| apiVersion | enum | Yes | 2017-01-01 | -| allowUpdates | boolean | No | A value indicating whether packages within the application may be overwritten using the same version string. | -| displayName | string | No | The display name for the application. | -| resources | array | No | [versions](./applications/versions.md) | - diff --git a/test/Resource/Expected/Batch/2017-01-01/batchAccounts/applications/versions.md b/test/Resource/Expected/Batch/2017-01-01/batchAccounts/applications/versions.md deleted file mode 100644 index 1420beb..0000000 --- a/test/Resource/Expected/Batch/2017-01-01/batchAccounts/applications/versions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.Batch/batchAccounts/applications/versions template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/applications/versions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/applications/versions", - "apiVersion": "2017-01-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/applications/versions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts/applications/versions | -| apiVersion | enum | Yes | 2017-01-01 | - diff --git a/test/Resource/Expected/Batch/2017-05-01/Microsoft.Batch.json b/test/Resource/Expected/Batch/2017-05-01/Microsoft.Batch.json deleted file mode 100644 index 416223d..0000000 --- a/test/Resource/Expected/Batch/2017-05-01/Microsoft.Batch.json +++ /dev/null @@ -1,296 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-05-01/Microsoft.Batch.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Batch", - "description": "Microsoft Batch Resource Types", - "resourceDefinitions": { - "batchAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-05-01" - ] - }, - "location": { - "type": "string", - "description": "The region in which to create the account." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The user-specified tags associated with the account." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BatchAccountCreateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the Batch account." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/batchAccounts_applications_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Batch/batchAccounts" - }, - "batchAccounts_applications": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/applications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-05-01" - ] - }, - "allowUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A value indicating whether packages within the application may be overwritten using the same version string." - }, - "displayName": { - "type": "string", - "description": "The display name for the application." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/batchAccounts_applications_versions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications" - }, - "batchAccounts_applications_versions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/applications/versions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-05-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications/versions" - } - }, - "definitions": { - "AutoStorageBaseProperties": { - "type": "object", - "properties": { - "storageAccountId": { - "type": "string", - "description": "The resource ID of the storage account to be used for auto-storage account." - } - }, - "required": [ - "storageAccountId" - ], - "description": "The properties related to the auto-storage account." - }, - "BatchAccountCreateProperties": { - "type": "object", - "properties": { - "autoStorage": { - "oneOf": [ - { - "$ref": "#/definitions/AutoStorageBaseProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties related to the auto-storage account." - }, - "poolAllocationMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "BatchService", - "UserSubscription" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService." - }, - "keyVaultReference": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to the Azure key vault associated with the Batch account." - } - }, - "description": "The properties of a Batch account." - }, - "batchAccounts_applications_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "applications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-05-01" - ] - }, - "allowUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A value indicating whether packages within the application may be overwritten using the same version string." - }, - "displayName": { - "type": "string", - "description": "The display name for the application." - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications" - }, - "batchAccounts_applications_versions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "versions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-05-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications/versions" - }, - "KeyVaultReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The resource ID of the Azure key vault associated with the Batch account." - }, - "url": { - "type": "string", - "description": "The URL of the Azure key vault associated with the Batch account." - } - }, - "required": [ - "id", - "url" - ], - "description": "Identifies the Azure key vault associated with a Batch account." - } - } -} diff --git a/test/Resource/Expected/Batch/2017-05-01/batchAccounts.md b/test/Resource/Expected/Batch/2017-05-01/batchAccounts.md deleted file mode 100644 index 0673909..0000000 --- a/test/Resource/Expected/Batch/2017-05-01/batchAccounts.md +++ /dev/null @@ -1,66 +0,0 @@ -# Microsoft.Batch/batchAccounts template reference -API Version: 2017-05-01 -## Template format - -To create a Microsoft.Batch/batchAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts", - "apiVersion": "2017-05-01", - "location": "string", - "tags": {}, - "properties": { - "autoStorage": { - "storageAccountId": "string" - }, - "poolAllocationMode": "string", - "keyVaultReference": { - "id": "string", - "url": "string" - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts | -| apiVersion | enum | Yes | 2017-05-01 | -| location | string | Yes | The region in which to create the account. | -| tags | object | No | The user-specified tags associated with the account. | -| properties | object | Yes | The properties of the Batch account. - [BatchAccountCreateProperties object](#BatchAccountCreateProperties) | -| resources | array | No | [applications](./batchAccounts/applications.md) | - - - -### BatchAccountCreateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| autoStorage | object | No | The properties related to the auto-storage account. - [AutoStorageBaseProperties object](#AutoStorageBaseProperties) | -| poolAllocationMode | enum | No | The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. - BatchService or UserSubscription | -| keyVaultReference | object | No | A reference to the Azure key vault associated with the Batch account. - [KeyVaultReference object](#KeyVaultReference) | - - - -### AutoStorageBaseProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountId | string | Yes | The resource ID of the storage account to be used for auto-storage account. | - - - -### KeyVaultReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | The resource ID of the Azure key vault associated with the Batch account. | -| url | string | Yes | The URL of the Azure key vault associated with the Batch account. | - diff --git a/test/Resource/Expected/Batch/2017-05-01/batchAccounts/applications.md b/test/Resource/Expected/Batch/2017-05-01/batchAccounts/applications.md deleted file mode 100644 index 1f68d55..0000000 --- a/test/Resource/Expected/Batch/2017-05-01/batchAccounts/applications.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.Batch/batchAccounts/applications template reference -API Version: 2017-05-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/applications resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/applications", - "apiVersion": "2017-05-01", - "allowUpdates": "boolean", - "displayName": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/applications object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts/applications | -| apiVersion | enum | Yes | 2017-05-01 | -| allowUpdates | boolean | No | A value indicating whether packages within the application may be overwritten using the same version string. | -| displayName | string | No | The display name for the application. | -| resources | array | No | [versions](./applications/versions.md) | - diff --git a/test/Resource/Expected/Batch/2017-05-01/batchAccounts/applications/versions.md b/test/Resource/Expected/Batch/2017-05-01/batchAccounts/applications/versions.md deleted file mode 100644 index 62bd920..0000000 --- a/test/Resource/Expected/Batch/2017-05-01/batchAccounts/applications/versions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.Batch/batchAccounts/applications/versions template reference -API Version: 2017-05-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/applications/versions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/applications/versions", - "apiVersion": "2017-05-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/applications/versions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts/applications/versions | -| apiVersion | enum | Yes | 2017-05-01 | - diff --git a/test/Resource/Expected/Batch/2017-09-01/Microsoft.Batch.json b/test/Resource/Expected/Batch/2017-09-01/Microsoft.Batch.json deleted file mode 100644 index cea0662..0000000 --- a/test/Resource/Expected/Batch/2017-09-01/Microsoft.Batch.json +++ /dev/null @@ -1,1507 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-09-01/Microsoft.Batch.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Batch", - "description": "Microsoft Batch Resource Types", - "resourceDefinitions": { - "batchAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "location": { - "type": "string", - "description": "The region in which to create the account." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The user-specified tags associated with the account." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BatchAccountCreateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the Batch account." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/batchAccounts_applications_childResource" - }, - { - "$ref": "#/definitions/batchAccounts_certificates_childResource" - }, - { - "$ref": "#/definitions/batchAccounts_pools_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Batch/batchAccounts" - }, - "batchAccounts_applications": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/applications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "allowUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A value indicating whether packages within the application may be overwritten using the same version string." - }, - "displayName": { - "type": "string", - "description": "The display name for the application." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/batchAccounts_applications_versions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications" - }, - "batchAccounts_applications_versions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/applications/versions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications/versions" - }, - "batchAccounts_certificates": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[\\w]+-[\\w]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CertificateCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties associated with the certificate." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Batch/batchAccounts/certificates" - }, - "batchAccounts_pools": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pool name. This must be unique within the account." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Batch/batchAccounts/pools" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PoolProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties associated with the pool." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Batch/batchAccounts/pools" - } - }, - "definitions": { - "ApplicationPackageReference": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "version": { - "type": "string", - "description": "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." - } - }, - "required": [ - "id" - ] - }, - "AutoScaleSettings": { - "type": "object", - "properties": { - "formula": { - "type": "string" - }, - "evaluationInterval": { - "type": "string", - "format": "duration", - "description": "If omitted, the default value is 15 minutes (PT15M)." - } - }, - "required": [ - "formula" - ] - }, - "AutoStorageBaseProperties": { - "type": "object", - "properties": { - "storageAccountId": { - "type": "string", - "description": "The resource ID of the storage account to be used for auto-storage account." - } - }, - "required": [ - "storageAccountId" - ], - "description": "The properties related to the auto-storage account." - }, - "AutoUserSpecification": { - "type": "object", - "properties": { - "scope": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Task", - "Pool" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "elevationLevel": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NonAdmin", - "Admin" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin." - } - } - }, - "BatchAccountCreateProperties": { - "type": "object", - "properties": { - "autoStorage": { - "oneOf": [ - { - "$ref": "#/definitions/AutoStorageBaseProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties related to the auto-storage account." - }, - "poolAllocationMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "BatchService", - "UserSubscription" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService." - }, - "keyVaultReference": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to the Azure key vault associated with the Batch account." - } - }, - "description": "The properties of a Batch account." - }, - "batchAccounts_applications_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "applications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "allowUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A value indicating whether packages within the application may be overwritten using the same version string." - }, - "displayName": { - "type": "string", - "description": "The display name for the application." - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications" - }, - "batchAccounts_applications_versions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "versions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Batch/batchAccounts/applications/versions" - }, - "batchAccounts_certificates_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[\\w]+-[\\w]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5." - }, - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CertificateCreateOrUpdateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties associated with the certificate." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Batch/batchAccounts/certificates" - }, - "batchAccounts_pools_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9_-]+$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pool name. This must be unique within the account." - }, - "type": { - "type": "string", - "enum": [ - "pools" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PoolProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties associated with the pool." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Batch/batchAccounts/pools" - }, - "CertificateCreateOrUpdateProperties": { - "type": "object", - "properties": { - "thumbprintAlgorithm": { - "type": "string", - "description": "This must match the first portion of the certificate name. Currently required to be 'SHA1'." - }, - "thumbprint": { - "type": "string", - "description": "This must match the thumbprint from the name." - }, - "format": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Pfx", - "Cer" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx." - }, - "data": { - "type": "string", - "description": "The maximum size is 10KB." - }, - "password": { - "type": "string", - "description": "This is required if the certificate format is pfx and must be omitted if the certificate format is cer." - } - }, - "required": [ - "data" - ], - "description": "Certificate properties for create operations" - }, - "CertificateReference": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "storeLocation": { - "oneOf": [ - { - "type": "string", - "enum": [ - "CurrentUser", - "LocalMachine" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory." - }, - "storeName": { - "type": "string", - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "StartTask", - "Task", - "RemoteUser" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Values are:\n\n starttask - The user account under which the start task is run.\n task - The accounts under which job tasks are run.\n remoteuser - The accounts under which users remotely access the node.\n\n You can specify more than one visibility in this collection. The default is all accounts." - } - }, - "required": [ - "id" - ] - }, - "CloudServiceConfiguration": { - "type": "object", - "properties": { - "osFamily": { - "type": "string", - "description": "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": { - "type": "string", - "description": "The default value is * which specifies the latest operating system version for the specified OS family." - }, - "currentOSVersion": { - "type": "string", - "description": "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." - } - }, - "required": [ - "osFamily" - ] - }, - "DataDisk": { - "type": "object", - "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If omitted, the default is \"Standard_LRS\". Values are:\n\n Standard_LRS - The data disk should use standard locally redundant storage.\n Premium_LRS - The data disk should use premium locally redundant storage." - } - }, - "required": [ - "lun", - "diskSizeGB" - ], - "description": "Data Disk settings which will be used by the data disks associated to Compute Nodes in the pool." - }, - "DeploymentConfiguration": { - "type": "object", - "properties": { - "cloudServiceConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/CloudServiceConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'." - }, - "virtualMachineConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified." - } - } - }, - "EnvironmentSetting": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "FixedScaleSettings": { - "type": "object", - "properties": { - "resizeTimeout": { - "type": "string", - "format": "duration", - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "At least one of targetDedicatedNodes, targetLowPriority nodes must be set." - }, - "targetLowPriorityNodes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "At least one of targetDedicatedNodes, targetLowPriority nodes must be set." - }, - "nodeDeallocationOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Requeue", - "Terminate", - "TaskCompletion", - "RetainedData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If omitted, the default value is Requeue." - } - } - }, - "ImageReference": { - "type": "object", - "properties": { - "publisher": { - "type": "string", - "description": "For example, Canonical or MicrosoftWindowsServer." - }, - "offer": { - "type": "string", - "description": "For example, UbuntuServer or WindowsServer." - }, - "sku": { - "type": "string", - "description": "For example, 14.04.0-LTS or 2012-R2-Datacenter." - }, - "version": { - "type": "string", - "description": "A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." - }, - "id": { - "type": "string", - "description": "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 ." - } - } - }, - "InboundNatPool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "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." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TCP", - "UDP" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "networkSecurityGroupRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkSecurityGroupRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "required": [ - "name", - "protocol", - "backendPort", - "frontendPortRangeStart", - "frontendPortRangeEnd" - ] - }, - "KeyVaultReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The resource ID of the Azure key vault associated with the Batch account." - }, - "url": { - "type": "string", - "description": "The URL of the Azure key vault associated with the Batch account." - } - }, - "required": [ - "id", - "url" - ], - "description": "Identifies the Azure key vault associated with a Batch account." - }, - "LinuxUserConfiguration": { - "type": "object", - "properties": { - "uid": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid." - }, - "gid": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid." - }, - "sshPrivateKey": { - "type": "string", - "description": "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)." - } - } - }, - "MetadataItem": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name", - "value" - ], - "description": "The Batch service does not assign any meaning to this metadata; it is solely for the use of user code." - }, - "NetworkConfiguration": { - "type": "object", - "properties": { - "subnetId": { - "type": "string", - "description": "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" - }, - "endpointConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/PoolEndpointConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property." - } - }, - "description": "The network configuration for a pool." - }, - "NetworkSecurityGroupRule": { - "type": "object", - "properties": { - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "sourceAddressPrefix": { - "type": "string", - "description": "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." - } - }, - "required": [ - "priority", - "access", - "sourceAddressPrefix" - ] - }, - "OSDisk": { - "type": "object", - "properties": { - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default value is none." - } - } - }, - "PoolEndpointConfiguration": { - "type": "object", - "properties": { - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "required": [ - "inboundNatPools" - ] - }, - "PoolProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." - }, - "vmSize": { - "type": "string", - "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. 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)." - }, - "deploymentConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/DeploymentConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS)." - }, - "scaleSettings": { - "oneOf": [ - { - "$ref": "#/definitions/ScaleSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "interNodeCommunication": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "networkConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "maxTasksPerNode": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "taskSchedulingPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/TaskSchedulingPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "userAccounts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/UserAccount" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "metadata": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/MetadataItem" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." - }, - "startTask": { - "oneOf": [ - { - "$ref": "#/definitions/StartTask" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool." - }, - "certificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/CertificateReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "applicationPackages": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationPackageReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "applicationLicenses": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "description": "Pool properties." - }, - "ResourceFile": { - "type": "object", - "properties": { - "blobSource": { - "type": "string", - "description": "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." - }, - "filePath": { - "type": "string" - }, - "fileMode": { - "type": "string", - "description": "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." - } - }, - "required": [ - "blobSource", - "filePath" - ] - }, - "ScaleSettings": { - "type": "object", - "properties": { - "fixedScale": { - "oneOf": [ - { - "$ref": "#/definitions/FixedScaleSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property and autoScale are mutually exclusive and one of the properties must be specified." - }, - "autoScale": { - "oneOf": [ - { - "$ref": "#/definitions/AutoScaleSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property and fixedScale are mutually exclusive and one of the properties must be specified." - } - }, - "description": "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": { - "type": "object", - "properties": { - "commandLine": { - "type": "string", - "description": "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." - }, - "resourceFiles": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceFile" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "environmentSettings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentSetting" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "userIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/UserIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If omitted, the task runs as a non-administrative user unique to the task." - }, - "maxTaskRetryCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit." - }, - "waitForSuccess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - } - }, - "TaskSchedulingPolicy": { - "type": "object", - "properties": { - "nodeFillType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Spread", - "Pack" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "nodeFillType" - ] - }, - "UserAccount": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "password": { - "type": "string" - }, - "elevationLevel": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NonAdmin", - "Admin" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin." - }, - "linuxUserConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxUserConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options." - } - }, - "required": [ - "name", - "password" - ] - }, - "UserIdentity": { - "type": "object", - "properties": { - "userName": { - "type": "string", - "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." - }, - "autoUser": { - "oneOf": [ - { - "$ref": "#/definitions/AutoUserSpecification" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." - } - }, - "description": "Specify either the userName or autoUser property, but not both." - }, - "VirtualMachineConfiguration": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "osDisk": { - "oneOf": [ - { - "$ref": "#/definitions/OSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "nodeAgentSkuId": { - "type": "string", - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property must not be specified if the imageReference specifies a Linux OS image." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them." - }, - "licenseType": { - "type": "string", - "description": "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:\n\n Windows_Server - The on-premises license is for Windows Server.\n Windows_Client - The on-premises license is for Windows Client.\n" - } - }, - "required": [ - "imageReference", - "nodeAgentSkuId" - ] - }, - "WindowsConfiguration": { - "type": "object", - "properties": { - "enableAutomaticUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If omitted, the default value is true." - } - } - } - } -} diff --git a/test/Resource/Expected/Batch/2017-09-01/batchAccounts.md b/test/Resource/Expected/Batch/2017-09-01/batchAccounts.md deleted file mode 100644 index 4e009dd..0000000 --- a/test/Resource/Expected/Batch/2017-09-01/batchAccounts.md +++ /dev/null @@ -1,66 +0,0 @@ -# Microsoft.Batch/batchAccounts template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Batch/batchAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts", - "apiVersion": "2017-09-01", - "location": "string", - "tags": {}, - "properties": { - "autoStorage": { - "storageAccountId": "string" - }, - "poolAllocationMode": "string", - "keyVaultReference": { - "id": "string", - "url": "string" - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts | -| apiVersion | enum | Yes | 2017-09-01 | -| location | string | Yes | The region in which to create the account. | -| tags | object | No | The user-specified tags associated with the account. | -| properties | object | Yes | The properties of the Batch account. - [BatchAccountCreateProperties object](#BatchAccountCreateProperties) | -| resources | array | No | [pools](./batchAccounts/pools.md) [certificates](./batchAccounts/certificates.md) [applications](./batchAccounts/applications.md) | - - - -### BatchAccountCreateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| autoStorage | object | No | The properties related to the auto-storage account. - [AutoStorageBaseProperties object](#AutoStorageBaseProperties) | -| poolAllocationMode | enum | No | The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. - BatchService or UserSubscription | -| keyVaultReference | object | No | A reference to the Azure key vault associated with the Batch account. - [KeyVaultReference object](#KeyVaultReference) | - - - -### AutoStorageBaseProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountId | string | Yes | The resource ID of the storage account to be used for auto-storage account. | - - - -### KeyVaultReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | The resource ID of the Azure key vault associated with the Batch account. | -| url | string | Yes | The URL of the Azure key vault associated with the Batch account. | - diff --git a/test/Resource/Expected/Batch/2017-09-01/batchAccounts/applications.md b/test/Resource/Expected/Batch/2017-09-01/batchAccounts/applications.md deleted file mode 100644 index 9aec462..0000000 --- a/test/Resource/Expected/Batch/2017-09-01/batchAccounts/applications.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.Batch/batchAccounts/applications template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/applications resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/applications", - "apiVersion": "2017-09-01", - "allowUpdates": "boolean", - "displayName": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/applications object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts/applications | -| apiVersion | enum | Yes | 2017-09-01 | -| allowUpdates | boolean | No | A value indicating whether packages within the application may be overwritten using the same version string. | -| displayName | string | No | The display name for the application. | -| resources | array | No | [versions](./applications/versions.md) | - diff --git a/test/Resource/Expected/Batch/2017-09-01/batchAccounts/applications/versions.md b/test/Resource/Expected/Batch/2017-09-01/batchAccounts/applications/versions.md deleted file mode 100644 index 8f1af16..0000000 --- a/test/Resource/Expected/Batch/2017-09-01/batchAccounts/applications/versions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.Batch/batchAccounts/applications/versions template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/applications/versions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/applications/versions", - "apiVersion": "2017-09-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/applications/versions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Batch/batchAccounts/applications/versions | -| apiVersion | enum | Yes | 2017-09-01 | - diff --git a/test/Resource/Expected/Batch/2017-09-01/batchAccounts/certificates.md b/test/Resource/Expected/Batch/2017-09-01/batchAccounts/certificates.md deleted file mode 100644 index 2bae955..0000000 --- a/test/Resource/Expected/Batch/2017-09-01/batchAccounts/certificates.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.Batch/batchAccounts/certificates template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/certificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/certificates", - "apiVersion": "2017-09-01", - "properties": { - "thumbprintAlgorithm": "string", - "thumbprint": "string", - "format": "string", - "data": "string", - "password": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/certificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5. | -| type | enum | Yes | Microsoft.Batch/batchAccounts/certificates | -| apiVersion | enum | Yes | 2017-09-01 | -| properties | object | Yes | The properties associated with the certificate. - [CertificateCreateOrUpdateProperties object](#CertificateCreateOrUpdateProperties) | - - - -### CertificateCreateOrUpdateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprintAlgorithm | string | No | This must match the first portion of the certificate name. Currently required to be 'SHA1'. | -| thumbprint | string | No | This must match the thumbprint from the name. | -| format | enum | No | The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. - Pfx or Cer | -| data | string | Yes | The maximum size is 10KB. | -| password | string | No | This is required if the certificate format is pfx and must be omitted if the certificate format is cer. | - diff --git a/test/Resource/Expected/Batch/2017-09-01/batchAccounts/pools.md b/test/Resource/Expected/Batch/2017-09-01/batchAccounts/pools.md deleted file mode 100644 index 65d584a..0000000 --- a/test/Resource/Expected/Batch/2017-09-01/batchAccounts/pools.md +++ /dev/null @@ -1,405 +0,0 @@ -# Microsoft.Batch/batchAccounts/pools template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Batch/batchAccounts/pools resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Batch/batchAccounts/pools", - "apiVersion": "2017-09-01", - "properties": { - "displayName": "string", - "vmSize": "string", - "deploymentConfiguration": { - "cloudServiceConfiguration": { - "osFamily": "string", - "targetOSVersion": "string", - "currentOSVersion": "string" - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string", - "id": "string" - }, - "osDisk": { - "caching": "string" - }, - "nodeAgentSkuId": "string", - "windowsConfiguration": { - "enableAutomaticUpdates": "boolean" - }, - "dataDisks": [ - { - "lun": "integer", - "caching": "string", - "diskSizeGB": "integer", - "storageAccountType": "string" - } - ], - "licenseType": "string" - } - }, - "scaleSettings": { - "fixedScale": { - "resizeTimeout": "string", - "targetDedicatedNodes": "integer", - "targetLowPriorityNodes": "integer", - "nodeDeallocationOption": "string" - }, - "autoScale": { - "formula": "string", - "evaluationInterval": "string" - } - }, - "interNodeCommunication": "string", - "networkConfiguration": { - "subnetId": "string", - "endpointConfiguration": { - "inboundNatPools": [ - { - "name": "string", - "protocol": "string", - "backendPort": "integer", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "networkSecurityGroupRules": [ - { - "priority": "integer", - "access": "string", - "sourceAddressPrefix": "string" - } - ] - } - ] - } - }, - "maxTasksPerNode": "integer", - "taskSchedulingPolicy": { - "nodeFillType": "string" - }, - "userAccounts": [ - { - "name": "string", - "password": "string", - "elevationLevel": "string", - "linuxUserConfiguration": { - "uid": "integer", - "gid": "integer", - "sshPrivateKey": "string" - } - } - ], - "metadata": [ - { - "name": "string", - "value": "string" - } - ], - "startTask": { - "commandLine": "string", - "resourceFiles": [ - { - "blobSource": "string", - "filePath": "string", - "fileMode": "string" - } - ], - "environmentSettings": [ - { - "name": "string", - "value": "string" - } - ], - "userIdentity": { - "userName": "string", - "autoUser": { - "scope": "string", - "elevationLevel": "string" - } - }, - "maxTaskRetryCount": "integer", - "waitForSuccess": "boolean" - }, - "certificates": [ - { - "id": "string", - "storeLocation": "string", - "storeName": "string", - "visibility": [ - "string" - ] - } - ], - "applicationPackages": [ - { - "id": "string", - "version": "string" - } - ], - "applicationLicenses": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Batch/batchAccounts/pools object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The pool name. This must be unique within the account. | -| type | enum | Yes | Microsoft.Batch/batchAccounts/pools | -| apiVersion | enum | Yes | 2017-09-01 | -| properties | object | Yes | The properties associated with the pool. - [PoolProperties object](#PoolProperties) | - - - -### PoolProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| displayName | string | No | The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. | -| vmSize | string | No | For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. 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). | -| deploymentConfiguration | object | No | Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS). - [DeploymentConfiguration object](#DeploymentConfiguration) | -| scaleSettings | object | No | [ScaleSettings object](#ScaleSettings) | -| interNodeCommunication | enum | No | 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'. - Enabled or Disabled | -| networkConfiguration | object | No | [NetworkConfiguration object](#NetworkConfiguration) | -| maxTasksPerNode | integer | No | | -| taskSchedulingPolicy | object | No | [TaskSchedulingPolicy object](#TaskSchedulingPolicy) | -| userAccounts | array | No | [UserAccount object](#UserAccount) | -| metadata | array | No | The Batch service does not assign any meaning to metadata; it is solely for the use of user code. - [MetadataItem object](#MetadataItem) | -| startTask | object | No | In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. - [StartTask object](#StartTask) | -| certificates | array | No | 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. - [CertificateReference object](#CertificateReference) | -| applicationPackages | array | No | 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. - [ApplicationPackageReference object](#ApplicationPackageReference) | -| applicationLicenses | array | No | 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. - string | - - - -### DeploymentConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| cloudServiceConfiguration | object | No | This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'. - [CloudServiceConfiguration object](#CloudServiceConfiguration) | -| virtualMachineConfiguration | object | No | This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. - [VirtualMachineConfiguration object](#VirtualMachineConfiguration) | - - - -### ScaleSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fixedScale | object | No | This property and autoScale are mutually exclusive and one of the properties must be specified. - [FixedScaleSettings object](#FixedScaleSettings) | -| autoScale | object | No | This property and fixedScale are mutually exclusive and one of the properties must be specified. - [AutoScaleSettings object](#AutoScaleSettings) | - - - -### NetworkConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnetId | string | No | 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 | -| endpointConfiguration | object | No | Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property. - [PoolEndpointConfiguration object](#PoolEndpointConfiguration) | - - - -### TaskSchedulingPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| nodeFillType | enum | Yes | Spread or Pack | - - - -### UserAccount object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| password | string | Yes | | -| elevationLevel | enum | No | nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. - NonAdmin or Admin | -| linuxUserConfiguration | object | No | This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. - [LinuxUserConfiguration object](#LinuxUserConfiguration) | - - - -### MetadataItem object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| value | string | Yes | | - - - -### StartTask object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| commandLine | string | No | 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. | -| resourceFiles | array | No | [ResourceFile object](#ResourceFile) | -| environmentSettings | array | No | [EnvironmentSetting object](#EnvironmentSetting) | -| userIdentity | object | No | If omitted, the task runs as a non-administrative user unique to the task. - [UserIdentity object](#UserIdentity) | -| maxTaskRetryCount | integer | No | The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. | -| waitForSuccess | boolean | No | 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. | - - - -### CertificateReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | | -| storeLocation | enum | No | The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. - CurrentUser or LocalMachine | -| storeName | string | No | 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 | array | No | Values are: starttask - The user account under which the start task is run. task - The accounts under which job tasks are run. remoteuser - The accounts under which users remotely access the node. You can specify more than one visibility in this collection. The default is all accounts. - StartTask, Task, RemoteUser | - - - -### ApplicationPackageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | | -| version | string | No | 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. | - - - -### CloudServiceConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osFamily | string | Yes | 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 | No | The default value is * which specifies the latest operating system version for the specified OS family. | -| currentOSVersion | string | No | 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. | - - - -### VirtualMachineConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | Yes | [ImageReference object](#ImageReference) | -| osDisk | object | No | [OSDisk object](#OSDisk) | -| nodeAgentSkuId | string | Yes | 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 | object | No | This property must not be specified if the imageReference specifies a Linux OS image. - [WindowsConfiguration object](#WindowsConfiguration) | -| dataDisks | array | No | This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. - [DataDisk object](#DataDisk) | -| licenseType | string | No | 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. | - - - -### FixedScaleSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| resizeTimeout | string | No | 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 | integer | No | At least one of targetDedicatedNodes, targetLowPriority nodes must be set. | -| targetLowPriorityNodes | integer | No | At least one of targetDedicatedNodes, targetLowPriority nodes must be set. | -| nodeDeallocationOption | enum | No | If omitted, the default value is Requeue. - Requeue, Terminate, TaskCompletion, RetainedData | - - - -### AutoScaleSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| formula | string | Yes | | -| evaluationInterval | string | No | If omitted, the default value is 15 minutes (PT15M). | - - - -### PoolEndpointConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| inboundNatPools | array | Yes | 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 object](#InboundNatPool) | - - - -### LinuxUserConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uid | integer | No | The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. | -| gid | integer | No | 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 | No | 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). | - - - -### ResourceFile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| blobSource | string | Yes | 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. | -| filePath | string | Yes | | -| fileMode | string | No | 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. | - - - -### EnvironmentSetting object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| value | string | No | | - - - -### UserIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| userName | string | No | The userName and autoUser properties are mutually exclusive; you must specify one but not both. | -| autoUser | object | No | The userName and autoUser properties are mutually exclusive; you must specify one but not both. - [AutoUserSpecification object](#AutoUserSpecification) | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publisher | string | No | For example, Canonical or MicrosoftWindowsServer. | -| offer | string | No | For example, UbuntuServer or WindowsServer. | -| sku | string | No | For example, 14.04.0-LTS or 2012-R2-Datacenter. | -| version | string | No | A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. | -| id | string | No | 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 . | - - - -### OSDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| caching | enum | No | Default value is none. - None, ReadOnly, ReadWrite | - - - -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enableAutomaticUpdates | boolean | No | If omitted, the default value is true. | - - - -### DataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. | -| caching | enum | No | Values are: none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. - None, ReadOnly, ReadWrite | -| diskSizeGB | integer | Yes | | -| storageAccountType | enum | No | If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage. - Standard_LRS or Premium_LRS | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | 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. | -| protocol | enum | Yes | TCP or UDP | -| backendPort | integer | Yes | 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. | -| frontendPortRangeStart | integer | Yes | 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. | -| frontendPortRangeEnd | integer | Yes | 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. | -| networkSecurityGroupRules | array | No | 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. - [NetworkSecurityGroupRule object](#NetworkSecurityGroupRule) | - - - -### AutoUserSpecification object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| scope | enum | No | 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. - Task or Pool | -| elevationLevel | enum | No | nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. - NonAdmin or Admin | - - - -### NetworkSecurityGroupRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| priority | integer | Yes | 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. | -| access | enum | Yes | Allow or Deny | -| sourceAddressPrefix | string | Yes | 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. | - diff --git a/test/Resource/Expected/Compute/2015-06-15/Microsoft.Compute.json b/test/Resource/Expected/Compute/2015-06-15/Microsoft.Compute.json deleted file mode 100644 index 479201c..0000000 --- a/test/Resource/Expected/Compute/2015-06-15/Microsoft.Compute.json +++ /dev/null @@ -1,2025 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-06-15/Microsoft.Compute.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Compute", - "description": "Microsoft Compute Resource Types", - "resourceDefinitions": { - "availabilitySets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-06-15" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AvailabilitySetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/availabilitySets" - }, - "virtualMachines": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-06-15" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachines_extensions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines" - }, - "virtualMachineScaleSets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-06-15" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set sku." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets" - }, - "virtualMachines_extensions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines/extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-06-15" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - } - }, - "definitions": { - "AdditionalUnattendContent": { - "type": "object", - "properties": { - "passName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "OobeSystem" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." - }, - "componentName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft-Windows-Shell-Setup" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." - }, - "settingName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AutoLogon", - "FirstLogonCommands" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." - }, - "content": { - "type": "string", - "description": "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." - } - }, - "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." - }, - "ApiEntityReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." - } - }, - "description": "The API entity reference." - }, - "AvailabilitySetProperties": { - "type": "object", - "properties": { - "platformUpdateDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Update Domain count." - }, - "platformFaultDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Fault Domain count." - }, - "virtualMachines": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references to all virtual machines in the availability set." - } - }, - "description": "The instance view of a resource." - }, - "BootDiagnostics": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether boot diagnostics should be enabled on the Virtual Machine." - }, - "storageUri": { - "type": "string", - "description": "Uri of the storage account to use for placing the console output and screenshot." - } - }, - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - }, - "DataDisk": { - "type": "object", - "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" - } - }, - "required": [ - "lun", - "name", - "vhd", - "createOption" - ], - "description": "Describes a data disk." - }, - "DiagnosticsProfile": { - "type": "object", - "properties": { - "bootDiagnostics": { - "oneOf": [ - { - "$ref": "#/definitions/BootDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - } - }, - "description": "Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15." - }, - "DiskEncryptionSettings": { - "type": "object", - "properties": { - "diskEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultSecretReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." - }, - "keyEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultKeyReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the key encryption key in Key Vault." - }, - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." - } - }, - "required": [ - "diskEncryptionKey" - ], - "description": "Describes a Encryption Settings for a Disk" - }, - "HardwareProfile": { - "type": "object", - "properties": { - "vmSize": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic_A0", - "Basic_A1", - "Basic_A2", - "Basic_A3", - "Basic_A4", - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the hardware settings for the virtual machine." - }, - "ImageReference": { - "type": "object", - "properties": { - "publisher": { - "type": "string", - "description": "The image publisher." - }, - "offer": { - "type": "string", - "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." - }, - "sku": { - "type": "string", - "description": "The image SKU." - }, - "version": { - "type": "string", - "description": "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." - } - }, - "description": "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." - }, - "InstanceViewStatus": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The status code." - }, - "level": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Info", - "Warning", - "Error" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The level code." - }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, - "message": { - "type": "string", - "description": "The detailed status message, including for alerts and error messages." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "The time of the status." - } - }, - "description": "Instance view status." - }, - "KeyVaultKeyReference": { - "type": "object", - "properties": { - "keyUrl": { - "type": "string", - "description": "The URL referencing a key encryption key in Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the key." - } - }, - "required": [ - "keyUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Key" - }, - "KeyVaultSecretReference": { - "type": "object", - "properties": { - "secretUrl": { - "type": "string", - "description": "The URL referencing a secret in a Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the secret." - } - }, - "required": [ - "secretUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Secret" - }, - "LinuxConfiguration": { - "type": "object", - "properties": { - "disablePasswordAuthentication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether password authentication should be disabled." - }, - "ssh": { - "oneOf": [ - { - "$ref": "#/definitions/SshConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the ssh key configuration for a Linux OS." - } - }, - "description": "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)." - }, - "NetworkInterfaceReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceReferenceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a network interface reference." - }, - "NetworkInterfaceReferenceProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - } - }, - "description": "Describes a network interface reference properties." - }, - "NetworkProfile": { - "type": "object", - "properties": { - "networkInterfaces": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." - } - }, - "description": "Specifies the network interfaces of the virtual machine." - }, - "OSDisk": { - "type": "object", - "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

**Windows**

**Linux**." - }, - "encryptionSettings": { - "oneOf": [ - { - "$ref": "#/definitions/DiskEncryptionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" - } - }, - "required": [ - "name", - "vhd", - "createOption" - ], - "description": "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)." - }, - "OSProfile": { - "type": "object", - "properties": { - "computerName": { - "type": "string", - "description": "Specifies the host OS name of the virtual machine.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "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)" - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies set of certificates that should be installed onto the virtual machine." - } - }, - "description": "Specifies the operating system settings for the virtual machine." - }, - "Plan": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The plan ID." - }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, - "product": { - "type": "string", - "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." - }, - "promotionCode": { - "type": "string", - "description": "The promotion code." - } - }, - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the number of virtual machines in the scale set." - } - }, - "description": "Describes a virtual machine scale set sku." - }, - "SshConfiguration": { - "type": "object", - "properties": { - "publicKeys": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of SSH public keys used to authenticate with linux based VMs." - } - }, - "description": "SSH configuration for Linux based VMs running on Azure" - }, - "SshPublicKey": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "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" - }, - "keyData": { - "type": "string", - "description": "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)." - } - }, - "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." - }, - "StorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/OSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the storage settings for the virtual machine disks." - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - } - }, - "UpgradePolicy": { - "type": "object", - "properties": { - "mode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Automatic", - "Manual" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "description": "Describes an upgrade policy - automatic or manual." - }, - "VaultCertificate": { - "type": "object", - "properties": { - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - }, - "certificateStore": { - "type": "string", - "description": "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." - } - }, - "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." - }, - "VaultSecretGroup": { - "type": "object", - "properties": { - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." - }, - "vaultCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of key vault references in SourceVault which contain certificates." - } - }, - "description": "Describes a set of certificates which are all in the same Key Vault." - }, - "VirtualHardDisk": { - "type": "object", - "properties": { - "uri": { - "type": "string", - "description": "Specifies the virtual hard disk's uri." - } - }, - "description": "Describes the uri of a disk." - }, - "VirtualMachineExtensionInstanceView": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The virtual machine extension name." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - }, - "statuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "instanceView": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionInstanceView" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine extension instance view." - } - }, - "description": "Describes the properties of a Virtual Machine Extension." - }, - "VirtualMachineProperties": { - "type": "object", - "properties": { - "hardwareProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HardwareProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/StorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/OSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machine." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the network interfaces of the virtual machine." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "availabilitySet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "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" - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "VirtualMachineScaleSetExtension": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The name of the extension." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetExtensionProfile": { - "type": "object", - "properties": { - "extensions": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set child extension resources." - } - }, - "description": "Describes a virtual machine scale set extension profile." - }, - "VirtualMachineScaleSetExtensionProperties": { - "type": "object", - "properties": { - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "The type of the extension handler." - }, - "typeHandlerVersion": { - "type": "string", - "description": "The type version of the extension handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the extension handler should be automatically upgraded across minor versions." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "Json formatted protected settings for the extension." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The IP configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetIPConfigurationProperties": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/ApiEntityReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The subnet." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load balancer backend address pools." - }, - "loadBalancerInboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load balancer inbound nat pools." - } - }, - "required": [ - "subnet" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration properties." - }, - "VirtualMachineScaleSetNetworkConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The network configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's network configurations." - }, - "VirtualMachineScaleSetNetworkConfigurationProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether this is a primary NIC on a virtual machine." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set IP Configuration." - } - }, - "required": [ - "ipConfigurations" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetNetworkProfile": { - "type": "object", - "properties": { - "networkInterfaceConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of network configurations." - } - }, - "description": "Describes a virtual machine scale set network profile." - }, - "VirtualMachineScaleSetOSDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." - }, - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." - }, - "vhdContainers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of virtual hard disk container uris." - } - }, - "required": [ - "name", - "createOption" - ], - "description": "Describes a virtual machine scale set operating system disk." - }, - "VirtualMachineScaleSetOSProfile": { - "type": "object", - "properties": { - "computerNamePrefix": { - "type": "string", - "description": "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." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "A base-64 encoded string of custom data." - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Windows Configuration of the OS profile." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Linux Configuration of the OS profile." - }, - "secrets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The List of certificates for addition to the VM." - } - }, - "description": "Describes a virtual machine scale set OS profile." - }, - "VirtualMachineScaleSetProperties": { - "type": "object", - "properties": { - "upgradePolicy": { - "oneOf": [ - { - "$ref": "#/definitions/UpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The upgrade policy." - }, - "virtualMachineProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine profile." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "overProvision": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set." - }, - "VirtualMachineScaleSetStorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The image reference." - }, - "osDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The OS disk." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "VirtualMachineScaleSetVMProfile": { - "type": "object", - "properties": { - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set OS profile." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set storage profile." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set network profile." - }, - "extensionProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set extension profile." - } - }, - "description": "Describes a virtual machine scale set virtual machine profile." - }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-06-15" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "WindowsConfiguration": { - "type": "object", - "properties": { - "provisionVMAgent": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "enableAutomaticUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether virtual machine is enabled for automatic updates." - }, - "timeZone": { - "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, - "additionalUnattendContent": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalUnattendContent" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." - }, - "winRM": { - "oneOf": [ - { - "$ref": "#/definitions/WinRMConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." - } - }, - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "WinRMConfiguration": { - "type": "object", - "properties": { - "listeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/WinRMListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of Windows Remote Management listeners" - } - }, - "description": "Describes Windows Remote Management configuration of the VM" - }, - "WinRMListener": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - } - }, - "description": "Describes Protocol and thumbprint of Windows Remote Management listener" - } - } -} diff --git a/test/Resource/Expected/Compute/2015-06-15/availabilitySets.md b/test/Resource/Expected/Compute/2015-06-15/availabilitySets.md deleted file mode 100644 index 04da81f..0000000 --- a/test/Resource/Expected/Compute/2015-06-15/availabilitySets.md +++ /dev/null @@ -1,55 +0,0 @@ -# Microsoft.Compute/availabilitySets template reference -API Version: 2015-06-15 -## Template format - -To create a Microsoft.Compute/availabilitySets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/availabilitySets", - "apiVersion": "2015-06-15", - "location": "string", - "tags": {}, - "properties": { - "platformUpdateDomainCount": "integer", - "platformFaultDomainCount": "integer", - "virtualMachines": [ - { - "id": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/availabilitySets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/availabilitySets | -| apiVersion | enum | Yes | 2015-06-15 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [AvailabilitySetProperties object](#AvailabilitySetProperties) | - - - -### AvailabilitySetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| platformUpdateDomainCount | integer | No | Update Domain count. | -| platformFaultDomainCount | integer | No | Fault Domain count. | -| virtualMachines | array | No | A list of references to all virtual machines in the availability set. - [SubResource object](#SubResource) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Compute/2015-06-15/virtualMachineScaleSets.md b/test/Resource/Expected/Compute/2015-06-15/virtualMachineScaleSets.md deleted file mode 100644 index 69e8bcd..0000000 --- a/test/Resource/Expected/Compute/2015-06-15/virtualMachineScaleSets.md +++ /dev/null @@ -1,409 +0,0 @@ -# Microsoft.Compute/virtualMachineScaleSets template reference -API Version: 2015-06-15 -## Template format - -To create a Microsoft.Compute/virtualMachineScaleSets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "apiVersion": "2015-06-15", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "properties": { - "upgradePolicy": { - "mode": "string" - }, - "virtualMachineProfile": { - "osProfile": { - "computerNamePrefix": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "storageProfile": { - "imageReference": { - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "name": "string", - "caching": "string", - "createOption": "string", - "osType": "string", - "image": { - "uri": "string" - }, - "vhdContainers": [ - "string" - ] - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "primary": "boolean", - "ipConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "subnet": { - "id": "string" - }, - "loadBalancerBackendAddressPools": [ - { - "id": "string" - } - ], - "loadBalancerInboundNatPools": [ - { - "id": "string" - } - ] - } - } - ] - } - } - ] - }, - "extensionProfile": { - "extensions": [ - { - "id": "string", - "name": "string", - "properties": { - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {} - } - } - ] - } - }, - "provisioningState": "string", - "overProvision": "boolean" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachineScaleSets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachineScaleSets | -| apiVersion | enum | Yes | 2015-06-15 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | The virtual machine scale set sku. - [Sku object](#Sku) | -| properties | object | Yes | [VirtualMachineScaleSetProperties object](#VirtualMachineScaleSetProperties) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The sku name. | -| tier | string | No | Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** | -| capacity | integer | No | Specifies the number of virtual machines in the scale set. | - - -     -### VirtualMachineScaleSetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| upgradePolicy | object | No | The upgrade policy. - [UpgradePolicy object](#UpgradePolicy) | -| virtualMachineProfile | object | No | The virtual machine profile. - [VirtualMachineScaleSetVMProfile object](#VirtualMachineScaleSetVMProfile) | -| provisioningState | string | No | The provisioning state, which only appears in the response. | -| overProvision | boolean | No | Specifies whether the Virtual Machine Scale Set should be overprovisioned. | - - - -### UpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| mode | enum | No | 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. - Automatic or Manual | - - -     -### VirtualMachineScaleSetVMProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osProfile | object | No | The virtual machine scale set OS profile. - [VirtualMachineScaleSetOSProfile object](#VirtualMachineScaleSetOSProfile) | -| storageProfile | object | No | The virtual machine scale set storage profile. - [VirtualMachineScaleSetStorageProfile object](#VirtualMachineScaleSetStorageProfile) | -| networkProfile | object | No | The virtual machine scale set network profile. - [VirtualMachineScaleSetNetworkProfile object](#VirtualMachineScaleSetNetworkProfile) | -| extensionProfile | object | No | The virtual machine scale set extension profile. - [VirtualMachineScaleSetExtensionProfile object](#VirtualMachineScaleSetExtensionProfile) | - - - -### VirtualMachineScaleSetOSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerNamePrefix | string | No | 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. | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | A base-64 encoded string of custom data. | -| windowsConfiguration | object | No | The Windows Configuration of the OS profile. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | The Linux Configuration of the OS profile. - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | The List of certificates for addition to the VM. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### VirtualMachineScaleSetStorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | The image reference. - [ImageReference object](#ImageReference) | -| osDisk | object | No | The OS disk. - [VirtualMachineScaleSetOSDisk object](#VirtualMachineScaleSetOSDisk) | - - - -### VirtualMachineScaleSetNetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| networkInterfaceConfigurations | array | No | The list of network configurations. - [VirtualMachineScaleSetNetworkConfiguration object](#VirtualMachineScaleSetNetworkConfiguration) | - - - -### VirtualMachineScaleSetExtensionProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| extensions | array | No | The virtual machine scale set child extension resources. - [VirtualMachineScaleSetExtension object](#VirtualMachineScaleSetExtension) | - - - -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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. | - - - -### VirtualMachineScaleSetOSDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The disk name. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. - FromImage, Empty, Attach | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| image | object | No | The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| vhdContainers | array | No | The list of virtual hard disk container uris. - string | - - -     -### VirtualMachineScaleSetNetworkConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The network configuration name. | -| properties | object | No | [VirtualMachineScaleSetNetworkConfigurationProperties object](#VirtualMachineScaleSetNetworkConfigurationProperties) | - - - -### VirtualMachineScaleSetExtension object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | No | The name of the extension. | -| properties | object | No | [VirtualMachineScaleSetExtensionProperties object](#VirtualMachineScaleSetExtensionProperties) | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### VirtualMachineScaleSetNetworkConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Whether this is a primary NIC on a virtual machine. | -| ipConfigurations | array | Yes | The virtual machine scale set IP Configuration. - [VirtualMachineScaleSetIPConfiguration object](#VirtualMachineScaleSetIPConfiguration) | - - - -### VirtualMachineScaleSetExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | The type of the extension handler. | -| typeHandlerVersion | string | No | The type version of the extension handler. | -| autoUpgradeMinorVersion | boolean | No | Whether the extension handler should be automatically upgraded across minor versions. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | Json formatted protected settings for the extension. | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - - -     -### VirtualMachineScaleSetIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The IP configuration name. | -| properties | object | No | [VirtualMachineScaleSetIPConfigurationProperties object](#VirtualMachineScaleSetIPConfigurationProperties) | - - - -### VirtualMachineScaleSetIPConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | Yes | The subnet. - [ApiEntityReference object](#ApiEntityReference) | -| loadBalancerBackendAddressPools | array | No | The load balancer backend address pools. - [SubResource object](#SubResource) | -| loadBalancerInboundNatPools | array | No | The load balancer inbound nat pools. - [SubResource object](#SubResource) | - - - -### ApiEntityReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... | - diff --git a/test/Resource/Expected/Compute/2015-06-15/virtualMachines.md b/test/Resource/Expected/Compute/2015-06-15/virtualMachines.md deleted file mode 100644 index 1930b17..0000000 --- a/test/Resource/Expected/Compute/2015-06-15/virtualMachines.md +++ /dev/null @@ -1,406 +0,0 @@ -# Microsoft.Compute/virtualMachines template reference -API Version: 2015-06-15 -## Template format - -To create a Microsoft.Compute/virtualMachines resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines", - "apiVersion": "2015-06-15", - "location": "string", - "tags": {}, - "plan": { - "name": "string", - "publisher": "string", - "product": "string", - "promotionCode": "string" - }, - "properties": { - "hardwareProfile": { - "vmSize": "string" - }, - "storageProfile": { - "imageReference": { - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "osType": "string", - "encryptionSettings": { - "diskEncryptionKey": { - "secretUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "keyEncryptionKey": { - "keyUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "enabled": "boolean" - }, - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer" - }, - "dataDisks": [ - { - "lun": "integer", - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer" - } - ] - }, - "osProfile": { - "computerName": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "string", - "properties": { - "primary": "boolean" - } - } - ] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": "boolean", - "storageUri": "string" - } - }, - "availabilitySet": { - "id": "string" - }, - "licenseType": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachines object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines | -| apiVersion | enum | Yes | 2015-06-15 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) | -| properties | object | Yes | [VirtualMachineProperties object](#VirtualMachineProperties) | -| resources | array | No | [extensions](./virtualMachines/extensions.md) | - - - -### Plan object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The plan ID. | -| publisher | string | No | The publisher ID. | -| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | -| promotionCode | string | No | The promotion code. | - - - -### VirtualMachineProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| hardwareProfile | object | No | Specifies the hardware settings for the virtual machine. - [HardwareProfile object](#HardwareProfile) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [StorageProfile object](#StorageProfile) | -| osProfile | object | No | Specifies the operating system settings for the virtual machine. - [OSProfile object](#OSProfile) | -| networkProfile | object | No | Specifies the network interfaces of the virtual machine. - [NetworkProfile object](#NetworkProfile) | -| diagnosticsProfile | object | No | Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - [DiagnosticsProfile object](#DiagnosticsProfile) | -| availabilitySet | object | No | Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. - [SubResource object](#SubResource) | -| licenseType | string | No | 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 | - - -     -### HardwareProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vmSize | enum | No | 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). - Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5 | - - -     -### StorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. - [ImageReference object](#ImageReference) | -| osDisk | object | No | Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [OSDisk object](#OSDisk) | -| dataDisks | array | No | 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). - [DataDisk object](#DataDisk) | - - -     -### OSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerName | string | No | Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | 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) | -| windowsConfiguration | object | No | Specifies Windows operating system settings on the virtual machine. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | Specifies the Linux operating system settings on the virtual machine.

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

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | Specifies set of certificates that should be installed onto the virtual machine. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### NetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| networkInterfaces | array | No | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. - [NetworkInterfaceReference object](#NetworkInterfaceReference) | - - - -### DiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bootDiagnostics | object | No | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor. - [BootDiagnostics object](#BootDiagnostics) | - - -     -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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 object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| encryptionSettings | object | No | Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 - [DiskEncryptionSettings object](#DiskEncryptionSettings) | -| name | string | Yes | The disk name. | -| vhd | object | Yes | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | - - -     -### DataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | 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 | Yes | The disk name. | -| vhd | object | Yes | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | - - -     -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### NetworkInterfaceReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceReferenceProperties object](#NetworkInterfaceReferenceProperties) | - - - -### BootDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | Whether boot diagnostics should be enabled on the Virtual Machine. | -| storageUri | string | No | Uri of the storage account to use for placing the console output and screenshot. | - - - -### DiskEncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| diskEncryptionKey | object | Yes | Specifies the location of the disk encryption key, which is a Key Vault Secret. - [KeyVaultSecretReference object](#KeyVaultSecretReference) | -| keyEncryptionKey | object | No | Specifies the location of the key encryption key in Key Vault. - [KeyVaultKeyReference object](#KeyVaultKeyReference) | -| enabled | boolean | No | Specifies whether disk encryption should be enabled on the virtual machine. | - - - -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### NetworkInterfaceReferenceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | - - - -### KeyVaultSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| secretUrl | string | Yes | The URL referencing a secret in a Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the secret. - [SubResource object](#SubResource) | - - - -### KeyVaultKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyUrl | string | Yes | The URL referencing a key encryption key in Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the key. - [SubResource object](#SubResource) | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - diff --git a/test/Resource/Expected/Compute/2015-06-15/virtualMachines/extensions.md b/test/Resource/Expected/Compute/2015-06-15/virtualMachines/extensions.md deleted file mode 100644 index 12d9b96..0000000 --- a/test/Resource/Expected/Compute/2015-06-15/virtualMachines/extensions.md +++ /dev/null @@ -1,98 +0,0 @@ -# Microsoft.Compute/virtualMachines/extensions template reference -API Version: 2015-06-15 -## Template format - -To create a Microsoft.Compute/virtualMachines/extensions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines/extensions", - "apiVersion": "2015-06-15", - "location": "string", - "tags": {}, - "properties": { - "forceUpdateTag": "string", - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "string", - "type": "string", - "typeHandlerVersion": "string", - "substatuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ], - "statuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/virtualMachines/extensions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines/extensions | -| apiVersion | enum | Yes | 2015-06-15 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualMachineExtensionProperties object](#VirtualMachineExtensionProperties) | - - - -### VirtualMachineExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceUpdateTag | string | No | How the extension handler should be forced to update even if the extension configuration has not changed. | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | -| instanceView | object | No | The virtual machine extension instance view. - [VirtualMachineExtensionInstanceView object](#VirtualMachineExtensionInstanceView) | - - - -### VirtualMachineExtensionInstanceView object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The virtual machine extension name. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| substatuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | -| statuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | - - - -### InstanceViewStatus object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| code | string | No | The status code. | -| level | enum | No | The level code. - Info, Warning, Error | -| displayStatus | string | No | The short localizable label for the status. | -| message | string | No | The detailed status message, including for alerts and error messages. | -| time | string | No | The time of the status. | - diff --git a/test/Resource/Expected/Compute/2015-11-01-preview/Microsoft.ContainerService.json b/test/Resource/Expected/Compute/2015-11-01-preview/Microsoft.ContainerService.json deleted file mode 100644 index 2a56410..0000000 --- a/test/Resource/Expected/Compute/2015-11-01-preview/Microsoft.ContainerService.json +++ /dev/null @@ -1,393 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-11-01-preview/Microsoft.ContainerService.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.ContainerService", - "description": "Microsoft ContainerService Resource Types", - "resourceDefinitions": { - "containerServices": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerService/containerServices" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-11-01-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerService/containerServices" - } - }, - "definitions": { - "ContainerServiceAgentPoolProfile": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Unique name of the agent pool profile within the context of the subscription and resource group" - }, - "count": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 100 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "No. of agents (VMs) that will host docker containers" - }, - "vmSize": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Size of agent VMs." - }, - "dnsPrefix": { - "type": "string", - "description": "DNS prefix to be used to create FQDN for this agent pool" - } - }, - "required": [ - "name", - "dnsPrefix" - ], - "description": "Profile for container service agent pool" - }, - "ContainerServiceDiagnosticsProfile": { - "type": "object", - "properties": { - "vmDiagnostics": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceVMDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Profile for container service VM diagnostic agent" - } - } - }, - "ContainerServiceLinuxProfile": { - "type": "object", - "properties": { - "adminUsername": { - "type": "string", - "description": "The administrator username to use for all Linux VMs" - }, - "ssh": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceSshConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the ssh key configuration for Linux VMs" - } - }, - "required": [ - "adminUsername", - "ssh" - ], - "description": "Profile for Linux VM" - }, - "ContainerServiceMasterProfile": { - "type": "object", - "properties": { - "count": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of masters (VMs) in the container cluster" - }, - "dnsPrefix": { - "type": "string", - "description": "DNS prefix to be used to create FQDN for master" - } - }, - "required": [ - "dnsPrefix" - ], - "description": "Profile for container service master" - }, - "ContainerServiceOrchestratorProfile": { - "type": "object", - "properties": { - "orchestratorType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Mesos", - "SwarmPreview", - "DCOS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies what orchestrator will be used to manage container cluster resources." - } - }, - "description": "Profile for Orchestrator" - }, - "ContainerServiceProperties": { - "type": "object", - "properties": { - "orchestratorProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceOrchestratorProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of orchestrator" - }, - "masterProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceMasterProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of master agents" - }, - "agentPoolProfiles": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ContainerServiceAgentPoolProfile" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of agent pools" - }, - "windowsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceWindowsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of Windows VMs" - }, - "linuxProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceLinuxProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties for Linux VMs" - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceDiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties for Diagnostic Agent" - } - }, - "required": [ - "masterProfile", - "agentPoolProfiles", - "linuxProfile" - ], - "description": "Properties of container service" - }, - "ContainerServiceSshConfiguration": { - "type": "object", - "properties": { - "publicKeys": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ContainerServiceSshPublicKey" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the list of SSH public keys used to authenticate with Linux based VMs" - } - }, - "description": "SSH configuration for Linux based VMs running on Azure" - }, - "ContainerServiceSshPublicKey": { - "type": "object", - "properties": { - "keyData": { - "type": "string", - "description": "Gets or sets Certificate public key used to authenticate with VM through SSH. The certificate must be in Pem format with or without headers." - } - }, - "required": [ - "keyData" - ], - "description": "Contains information about SSH certificate public key data." - }, - "ContainerServiceVMDiagnostics": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine." - } - }, - "description": "Describes VM Diagnostics." - }, - "ContainerServiceWindowsProfile": { - "type": "object", - "properties": { - "adminUsername": { - "type": "string", - "description": "The administrator username to use for Windows jumpbox" - }, - "adminPassword": { - "type": "string", - "description": "The administrator password to use for Windows jumpbox" - } - }, - "required": [ - "adminUsername", - "adminPassword" - ], - "description": "Profile for Windows jumpbox" - } - } -} diff --git a/test/Resource/Expected/Compute/2015-11-01-preview/containerServices.md b/test/Resource/Expected/Compute/2015-11-01-preview/containerServices.md deleted file mode 100644 index dc765cc..0000000 --- a/test/Resource/Expected/Compute/2015-11-01-preview/containerServices.md +++ /dev/null @@ -1,147 +0,0 @@ -# Microsoft.ContainerService/containerServices template reference -API Version: 2015-11-01-preview -## Template format - -To create a Microsoft.ContainerService/containerServices resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerService/containerServices", - "apiVersion": "2015-11-01-preview", - "location": "string", - "tags": {}, - "properties": { - "orchestratorProfile": { - "orchestratorType": "string" - }, - "masterProfile": { - "count": "integer", - "dnsPrefix": "string" - }, - "agentPoolProfiles": [ - { - "name": "string", - "count": "integer", - "vmSize": "string", - "dnsPrefix": "string" - } - ], - "windowsProfile": { - "adminUsername": "string", - "adminPassword": "string" - }, - "linuxProfile": { - "adminUsername": "string", - "ssh": { - "publicKeys": [ - { - "keyData": "string" - } - ] - } - }, - "diagnosticsProfile": { - "vmDiagnostics": { - "enabled": "boolean" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerService/containerServices object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.ContainerService/containerServices | -| apiVersion | enum | Yes | 2015-11-01-preview | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [ContainerServiceProperties object](#ContainerServiceProperties) | - - - -### ContainerServiceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| orchestratorProfile | object | No | Properties of orchestrator - [ContainerServiceOrchestratorProfile object](#ContainerServiceOrchestratorProfile) | -| masterProfile | object | Yes | Properties of master agents - [ContainerServiceMasterProfile object](#ContainerServiceMasterProfile) | -| agentPoolProfiles | array | Yes | Properties of agent pools - [ContainerServiceAgentPoolProfile object](#ContainerServiceAgentPoolProfile) | -| windowsProfile | object | No | Properties of Windows VMs - [ContainerServiceWindowsProfile object](#ContainerServiceWindowsProfile) | -| linuxProfile | object | Yes | Properties for Linux VMs - [ContainerServiceLinuxProfile object](#ContainerServiceLinuxProfile) | -| diagnosticsProfile | object | No | Properties for Diagnostic Agent - [ContainerServiceDiagnosticsProfile object](#ContainerServiceDiagnosticsProfile) | - - - -### ContainerServiceOrchestratorProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| orchestratorType | enum | No | Specifies what orchestrator will be used to manage container cluster resources. - Mesos, SwarmPreview, DCOS | - - - -### ContainerServiceMasterProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| count | integer | No | Number of masters (VMs) in the container cluster | -| dnsPrefix | string | Yes | DNS prefix to be used to create FQDN for master | - - - -### ContainerServiceAgentPoolProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Unique name of the agent pool profile within the context of the subscription and resource group | -| count | integer | No | No. of agents (VMs) that will host docker containers | -| vmSize | enum | No | Size of agent VMs. - Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5 | -| dnsPrefix | string | Yes | DNS prefix to be used to create FQDN for this agent pool | - - - -### ContainerServiceWindowsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUsername | string | Yes | The administrator username to use for Windows jumpbox | -| adminPassword | string | Yes | The administrator password to use for Windows jumpbox | - - - -### ContainerServiceLinuxProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUsername | string | Yes | The administrator username to use for all Linux VMs | -| ssh | object | Yes | Specifies the ssh key configuration for Linux VMs - [ContainerServiceSshConfiguration object](#ContainerServiceSshConfiguration) | - - - -### ContainerServiceDiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vmDiagnostics | object | No | Profile for container service VM diagnostic agent - [ContainerServiceVMDiagnostics object](#ContainerServiceVMDiagnostics) | - - - -### ContainerServiceSshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | Gets or sets the list of SSH public keys used to authenticate with Linux based VMs - [ContainerServiceSshPublicKey object](#ContainerServiceSshPublicKey) | - - - -### ContainerServiceVMDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine. | - - - -### ContainerServiceSshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyData | string | Yes | Gets or sets Certificate public key used to authenticate with VM through SSH. The certificate must be in Pem format with or without headers. | - diff --git a/test/Resource/Expected/Compute/2016-03-30/Microsoft.Compute.json b/test/Resource/Expected/Compute/2016-03-30/Microsoft.Compute.json deleted file mode 100644 index 986fc42..0000000 --- a/test/Resource/Expected/Compute/2016-03-30/Microsoft.Compute.json +++ /dev/null @@ -1,2105 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-03-30/Microsoft.Compute.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Compute", - "description": "Microsoft Compute Resource Types", - "resourceDefinitions": { - "availabilitySets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AvailabilitySetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/availabilitySets" - }, - "virtualMachines": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the virtual machine, if configured." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachines_extensions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines" - }, - "virtualMachineScaleSets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set sku." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the virtual machine scale set, if configured." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets" - }, - "virtualMachines_extensions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines/extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - } - }, - "definitions": { - "AdditionalUnattendContent": { - "type": "object", - "properties": { - "passName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "OobeSystem" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." - }, - "componentName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft-Windows-Shell-Setup" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." - }, - "settingName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AutoLogon", - "FirstLogonCommands" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." - }, - "content": { - "type": "string", - "description": "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." - } - }, - "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." - }, - "ApiEntityReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." - } - }, - "description": "The API entity reference." - }, - "AvailabilitySetProperties": { - "type": "object", - "properties": { - "platformUpdateDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Update Domain count." - }, - "platformFaultDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Fault Domain count." - }, - "virtualMachines": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references to all virtual machines in the availability set." - } - }, - "description": "The instance view of a resource." - }, - "BootDiagnostics": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether boot diagnostics should be enabled on the Virtual Machine." - }, - "storageUri": { - "type": "string", - "description": "Uri of the storage account to use for placing the console output and screenshot." - } - }, - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - }, - "DataDisk": { - "type": "object", - "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - } - }, - "required": [ - "lun", - "name", - "vhd", - "createOption" - ], - "description": "Describes a data disk." - }, - "DiagnosticsProfile": { - "type": "object", - "properties": { - "bootDiagnostics": { - "oneOf": [ - { - "$ref": "#/definitions/BootDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - } - }, - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "DiskEncryptionSettings": { - "type": "object", - "properties": { - "diskEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultSecretReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." - }, - "keyEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultKeyReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the key encryption key in Key Vault." - }, - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." - } - }, - "description": "Describes a Encryption Settings for a Disk" - }, - "HardwareProfile": { - "type": "object", - "properties": { - "vmSize": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic_A0", - "Basic_A1", - "Basic_A2", - "Basic_A3", - "Basic_A4", - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_D15_v2", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_DS1_v2", - "Standard_DS2_v2", - "Standard_DS3_v2", - "Standard_DS4_v2", - "Standard_DS5_v2", - "Standard_DS11_v2", - "Standard_DS12_v2", - "Standard_DS13_v2", - "Standard_DS14_v2", - "Standard_DS15_v2", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the hardware settings for the virtual machine." - }, - "ImageReference": { - "type": "object", - "properties": { - "publisher": { - "type": "string", - "description": "The image publisher." - }, - "offer": { - "type": "string", - "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." - }, - "sku": { - "type": "string", - "description": "The image SKU." - }, - "version": { - "type": "string", - "description": "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." - } - }, - "description": "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." - }, - "InstanceViewStatus": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The status code." - }, - "level": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Info", - "Warning", - "Error" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The level code." - }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, - "message": { - "type": "string", - "description": "The detailed status message, including for alerts and error messages." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "The time of the status." - } - }, - "description": "Instance view status." - }, - "KeyVaultKeyReference": { - "type": "object", - "properties": { - "keyUrl": { - "type": "string", - "description": "The URL referencing a key encryption key in Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the key." - } - }, - "required": [ - "keyUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Key" - }, - "KeyVaultSecretReference": { - "type": "object", - "properties": { - "secretUrl": { - "type": "string", - "description": "The URL referencing a secret in a Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the secret." - } - }, - "required": [ - "secretUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Secret" - }, - "LinuxConfiguration": { - "type": "object", - "properties": { - "disablePasswordAuthentication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether password authentication should be disabled." - }, - "ssh": { - "oneOf": [ - { - "$ref": "#/definitions/SshConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the ssh key configuration for a Linux OS." - } - }, - "description": "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)." - }, - "NetworkInterfaceReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceReferenceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a network interface reference." - }, - "NetworkInterfaceReferenceProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - } - }, - "description": "Describes a network interface reference properties." - }, - "NetworkProfile": { - "type": "object", - "properties": { - "networkInterfaces": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." - } - }, - "description": "Specifies the network interfaces of the virtual machine." - }, - "OSDisk": { - "type": "object", - "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**." - }, - "encryptionSettings": { - "oneOf": [ - { - "$ref": "#/definitions/DiskEncryptionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - } - }, - "required": [ - "name", - "vhd", - "createOption" - ], - "description": "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)." - }, - "OSProfile": { - "type": "object", - "properties": { - "computerName": { - "type": "string", - "description": "Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "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)" - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies set of certificates that should be installed onto the virtual machine." - } - }, - "description": "Specifies the operating system settings for the virtual machine." - }, - "Plan": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The plan ID." - }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, - "product": { - "type": "string", - "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." - }, - "promotionCode": { - "type": "string", - "description": "The promotion code." - } - }, - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the number of virtual machines in the scale set." - } - }, - "description": "Describes a virtual machine scale set sku." - }, - "SshConfiguration": { - "type": "object", - "properties": { - "publicKeys": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of SSH public keys used to authenticate with linux based VMs." - } - }, - "description": "SSH configuration for Linux based VMs running on Azure" - }, - "SshPublicKey": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "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" - }, - "keyData": { - "type": "string", - "description": "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)." - } - }, - "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." - }, - "StorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/OSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the storage settings for the virtual machine disks." - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - } - }, - "UpgradePolicy": { - "type": "object", - "properties": { - "mode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Automatic", - "Manual" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "description": "Describes an upgrade policy - automatic or manual." - }, - "VaultCertificate": { - "type": "object", - "properties": { - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - }, - "certificateStore": { - "type": "string", - "description": "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." - } - }, - "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." - }, - "VaultSecretGroup": { - "type": "object", - "properties": { - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." - }, - "vaultCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of key vault references in SourceVault which contain certificates." - } - }, - "description": "Describes a set of certificates which are all in the same Key Vault." - }, - "VirtualHardDisk": { - "type": "object", - "properties": { - "uri": { - "type": "string", - "description": "Specifies the virtual hard disk's uri." - } - }, - "description": "Describes the uri of a disk." - }, - "VirtualMachineExtensionInstanceView": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The virtual machine extension name." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - }, - "statuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "instanceView": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionInstanceView" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine extension instance view." - } - }, - "description": "Describes the properties of a Virtual Machine Extension." - }, - "VirtualMachineIdentity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." - } - }, - "description": "Identity for the virtual machine." - }, - "VirtualMachineProperties": { - "type": "object", - "properties": { - "hardwareProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HardwareProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/StorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/OSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machine." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the network interfaces of the virtual machine." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "availabilitySet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "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" - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "VirtualMachineScaleSetExtension": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The name of the extension." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetExtensionProfile": { - "type": "object", - "properties": { - "extensions": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set child extension resources." - } - }, - "description": "Describes a virtual machine scale set extension profile." - }, - "VirtualMachineScaleSetExtensionProperties": { - "type": "object", - "properties": { - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "The type of the extension handler." - }, - "typeHandlerVersion": { - "type": "string", - "description": "The type version of the extension handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the extension handler should be automatically upgraded across minor versions." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "Json formatted protected settings for the extension." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetIdentity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." - } - }, - "description": "Identity for the virtual machine scale set." - }, - "VirtualMachineScaleSetIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The IP configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetIPConfigurationProperties": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/ApiEntityReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The subnet." - }, - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The application gateway backend address pools." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load balancer backend address pools." - }, - "loadBalancerInboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load balancer inbound nat pools." - } - }, - "required": [ - "subnet" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration properties." - }, - "VirtualMachineScaleSetNetworkConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The network configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's network configurations." - }, - "VirtualMachineScaleSetNetworkConfigurationProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether this is a primary NIC on a virtual machine." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set IP Configuration." - } - }, - "required": [ - "ipConfigurations" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetNetworkProfile": { - "type": "object", - "properties": { - "networkInterfaceConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of network configurations." - } - }, - "description": "Describes a virtual machine scale set network profile." - }, - "VirtualMachineScaleSetOSDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." - }, - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." - }, - "vhdContainers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of virtual hard disk container uris." - } - }, - "required": [ - "name", - "createOption" - ], - "description": "Describes a virtual machine scale set operating system disk." - }, - "VirtualMachineScaleSetOSProfile": { - "type": "object", - "properties": { - "computerNamePrefix": { - "type": "string", - "description": "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." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "A base-64 encoded string of custom data." - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Windows Configuration of the OS profile." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Linux Configuration of the OS profile." - }, - "secrets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The List of certificates for addition to the VM." - } - }, - "description": "Describes a virtual machine scale set OS profile." - }, - "VirtualMachineScaleSetProperties": { - "type": "object", - "properties": { - "upgradePolicy": { - "oneOf": [ - { - "$ref": "#/definitions/UpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The upgrade policy." - }, - "virtualMachineProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine profile." - }, - "overProvision": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set." - }, - "VirtualMachineScaleSetStorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The image reference." - }, - "osDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The OS disk." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "VirtualMachineScaleSetVMProfile": { - "type": "object", - "properties": { - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set OS profile." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set storage profile." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set network profile." - }, - "extensionProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set extension profile." - } - }, - "description": "Describes a virtual machine scale set virtual machine profile." - }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "WindowsConfiguration": { - "type": "object", - "properties": { - "provisionVMAgent": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "enableAutomaticUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether virtual machine is enabled for automatic updates." - }, - "timeZone": { - "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, - "additionalUnattendContent": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalUnattendContent" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." - }, - "winRM": { - "oneOf": [ - { - "$ref": "#/definitions/WinRMConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." - } - }, - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "WinRMConfiguration": { - "type": "object", - "properties": { - "listeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/WinRMListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of Windows Remote Management listeners" - } - }, - "description": "Describes Windows Remote Management configuration of the VM" - }, - "WinRMListener": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - } - }, - "description": "Describes Protocol and thumbprint of Windows Remote Management listener" - } - } -} diff --git a/test/Resource/Expected/Compute/2016-03-30/Microsoft.ContainerService.json b/test/Resource/Expected/Compute/2016-03-30/Microsoft.ContainerService.json deleted file mode 100644 index ea0fb98..0000000 --- a/test/Resource/Expected/Compute/2016-03-30/Microsoft.ContainerService.json +++ /dev/null @@ -1,406 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-03-30/Microsoft.ContainerService.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.ContainerService", - "description": "Microsoft ContainerService Resource Types", - "resourceDefinitions": { - "containerServices": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerService/containerServices" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerService/containerServices" - } - }, - "definitions": { - "ContainerServiceAgentPoolProfile": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Unique name of the agent pool profile in the context of the subscription and resource group." - }, - "count": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 100 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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. " - }, - "vmSize": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Size of agent VMs." - }, - "dnsPrefix": { - "type": "string", - "description": "DNS prefix to be used to create the FQDN for the agent pool." - } - }, - "required": [ - "name", - "vmSize", - "dnsPrefix" - ], - "description": "Profile for the container service agent pool." - }, - "ContainerServiceDiagnosticsProfile": { - "type": "object", - "properties": { - "vmDiagnostics": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceVMDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Profile for the container service VM diagnostic agent." - } - }, - "required": [ - "vmDiagnostics" - ] - }, - "ContainerServiceLinuxProfile": { - "type": "object", - "properties": { - "adminUsername": { - "type": "string", - "description": "The administrator username to use for all Linux VMs" - }, - "ssh": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceSshConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ssh key configuration for Linux VMs." - } - }, - "required": [ - "adminUsername", - "ssh" - ], - "description": "Profile for Linux VMs in the container service cluster." - }, - "ContainerServiceMasterProfile": { - "type": "object", - "properties": { - "count": { - "oneOf": [ - { - "type": "integer", - "default": "1" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1." - }, - "dnsPrefix": { - "type": "string", - "description": "DNS prefix to be used to create the FQDN for master." - } - }, - "required": [ - "dnsPrefix" - ], - "description": "Profile for the container service master." - }, - "ContainerServiceOrchestratorProfile": { - "type": "object", - "properties": { - "orchestratorType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Swarm", - "DCOS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom." - } - }, - "required": [ - "orchestratorType" - ], - "description": "Profile for the container service orchestrator." - }, - "ContainerServiceProperties": { - "type": "object", - "properties": { - "orchestratorProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceOrchestratorProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the orchestrator." - }, - "masterProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceMasterProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of master agents." - }, - "agentPoolProfiles": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ContainerServiceAgentPoolProfile" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the agent pool." - }, - "windowsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceWindowsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of Windows VMs." - }, - "linuxProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceLinuxProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of Linux VMs." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceDiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the diagnostic agent." - } - }, - "required": [ - "masterProfile", - "agentPoolProfiles", - "linuxProfile" - ], - "description": "Properties of the container service." - }, - "ContainerServiceSshConfiguration": { - "type": "object", - "properties": { - "publicKeys": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ContainerServiceSshPublicKey" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the list of SSH public keys used to authenticate with Linux-based VMs." - } - }, - "required": [ - "publicKeys" - ], - "description": "SSH configuration for Linux-based VMs running on Azure." - }, - "ContainerServiceSshPublicKey": { - "type": "object", - "properties": { - "keyData": { - "type": "string", - "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." - } - }, - "required": [ - "keyData" - ], - "description": "Contains information about SSH certificate public key data." - }, - "ContainerServiceVMDiagnostics": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the VM diagnostic agent is provisioned on the VM." - } - }, - "required": [ - "enabled" - ], - "description": "Profile for diagnostics on the container service VMs." - }, - "ContainerServiceWindowsProfile": { - "type": "object", - "properties": { - "adminUsername": { - "type": "string", - "description": "The administrator username to use for Windows VMs" - }, - "adminPassword": { - "type": "string", - "description": "The administrator password to use for Windows VMs" - } - }, - "required": [ - "adminUsername", - "adminPassword" - ], - "description": "Profile for Windows VMs in the container service cluster." - } - } -} diff --git a/test/Resource/Expected/Compute/2016-03-30/availabilitySets.md b/test/Resource/Expected/Compute/2016-03-30/availabilitySets.md deleted file mode 100644 index d431e64..0000000 --- a/test/Resource/Expected/Compute/2016-03-30/availabilitySets.md +++ /dev/null @@ -1,55 +0,0 @@ -# Microsoft.Compute/availabilitySets template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Compute/availabilitySets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/availabilitySets", - "apiVersion": "2016-03-30", - "location": "string", - "tags": {}, - "properties": { - "platformUpdateDomainCount": "integer", - "platformFaultDomainCount": "integer", - "virtualMachines": [ - { - "id": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/availabilitySets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/availabilitySets | -| apiVersion | enum | Yes | 2016-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [AvailabilitySetProperties object](#AvailabilitySetProperties) | - - - -### AvailabilitySetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| platformUpdateDomainCount | integer | No | Update Domain count. | -| platformFaultDomainCount | integer | No | Fault Domain count. | -| virtualMachines | array | No | A list of references to all virtual machines in the availability set. - [SubResource object](#SubResource) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Compute/2016-03-30/containerServices.md b/test/Resource/Expected/Compute/2016-03-30/containerServices.md deleted file mode 100644 index 3f8cb62..0000000 --- a/test/Resource/Expected/Compute/2016-03-30/containerServices.md +++ /dev/null @@ -1,147 +0,0 @@ -# Microsoft.ContainerService/containerServices template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.ContainerService/containerServices resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerService/containerServices", - "apiVersion": "2016-03-30", - "location": "string", - "tags": {}, - "properties": { - "orchestratorProfile": { - "orchestratorType": "string" - }, - "masterProfile": { - "count": "integer", - "dnsPrefix": "string" - }, - "agentPoolProfiles": [ - { - "name": "string", - "count": "integer", - "vmSize": "string", - "dnsPrefix": "string" - } - ], - "windowsProfile": { - "adminUsername": "string", - "adminPassword": "string" - }, - "linuxProfile": { - "adminUsername": "string", - "ssh": { - "publicKeys": [ - { - "keyData": "string" - } - ] - } - }, - "diagnosticsProfile": { - "vmDiagnostics": { - "enabled": "boolean" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerService/containerServices object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.ContainerService/containerServices | -| apiVersion | enum | Yes | 2016-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [ContainerServiceProperties object](#ContainerServiceProperties) | - - - -### ContainerServiceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| orchestratorProfile | object | No | Properties of the orchestrator. - [ContainerServiceOrchestratorProfile object](#ContainerServiceOrchestratorProfile) | -| masterProfile | object | Yes | Properties of master agents. - [ContainerServiceMasterProfile object](#ContainerServiceMasterProfile) | -| agentPoolProfiles | array | Yes | Properties of the agent pool. - [ContainerServiceAgentPoolProfile object](#ContainerServiceAgentPoolProfile) | -| windowsProfile | object | No | Properties of Windows VMs. - [ContainerServiceWindowsProfile object](#ContainerServiceWindowsProfile) | -| linuxProfile | object | Yes | Properties of Linux VMs. - [ContainerServiceLinuxProfile object](#ContainerServiceLinuxProfile) | -| diagnosticsProfile | object | No | Properties of the diagnostic agent. - [ContainerServiceDiagnosticsProfile object](#ContainerServiceDiagnosticsProfile) | - - - -### ContainerServiceOrchestratorProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| orchestratorType | enum | Yes | The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom. - Swarm or DCOS | - - - -### ContainerServiceMasterProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| count | integer | No | Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. | -| dnsPrefix | string | Yes | DNS prefix to be used to create the FQDN for master. | - - - -### ContainerServiceAgentPoolProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Unique name of the agent pool profile in the context of the subscription and resource group. | -| count | integer | No | 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. | -| vmSize | enum | Yes | Size of agent VMs. - Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5 | -| dnsPrefix | string | Yes | DNS prefix to be used to create the FQDN for the agent pool. | - - - -### ContainerServiceWindowsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUsername | string | Yes | The administrator username to use for Windows VMs | -| adminPassword | string | Yes | The administrator password to use for Windows VMs | - - - -### ContainerServiceLinuxProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUsername | string | Yes | The administrator username to use for all Linux VMs | -| ssh | object | Yes | The ssh key configuration for Linux VMs. - [ContainerServiceSshConfiguration object](#ContainerServiceSshConfiguration) | - - - -### ContainerServiceDiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vmDiagnostics | object | Yes | Profile for the container service VM diagnostic agent. - [ContainerServiceVMDiagnostics object](#ContainerServiceVMDiagnostics) | - - - -### ContainerServiceSshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | Yes | the list of SSH public keys used to authenticate with Linux-based VMs. - [ContainerServiceSshPublicKey object](#ContainerServiceSshPublicKey) | - - - -### ContainerServiceVMDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether the VM diagnostic agent is provisioned on the VM. | - - - -### ContainerServiceSshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyData | string | Yes | Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. | - diff --git a/test/Resource/Expected/Compute/2016-03-30/virtualMachineScaleSets.md b/test/Resource/Expected/Compute/2016-03-30/virtualMachineScaleSets.md deleted file mode 100644 index 3f2c4ea..0000000 --- a/test/Resource/Expected/Compute/2016-03-30/virtualMachineScaleSets.md +++ /dev/null @@ -1,424 +0,0 @@ -# Microsoft.Compute/virtualMachineScaleSets template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Compute/virtualMachineScaleSets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "apiVersion": "2016-03-30", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "properties": { - "upgradePolicy": { - "mode": "string" - }, - "virtualMachineProfile": { - "osProfile": { - "computerNamePrefix": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "storageProfile": { - "imageReference": { - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "name": "string", - "caching": "string", - "createOption": "string", - "osType": "string", - "image": { - "uri": "string" - }, - "vhdContainers": [ - "string" - ] - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "primary": "boolean", - "ipConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "subnet": { - "id": "string" - }, - "applicationGatewayBackendAddressPools": [ - { - "id": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string" - } - ], - "loadBalancerInboundNatPools": [ - { - "id": "string" - } - ] - } - } - ] - } - } - ] - }, - "extensionProfile": { - "extensions": [ - { - "id": "string", - "name": "string", - "properties": { - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {} - } - } - ] - } - }, - "overProvision": "boolean" - }, - "identity": { - "type": "SystemAssigned" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachineScaleSets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachineScaleSets | -| apiVersion | enum | Yes | 2016-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | The virtual machine scale set sku. - [Sku object](#Sku) | -| properties | object | Yes | [VirtualMachineScaleSetProperties object](#VirtualMachineScaleSetProperties) | -| identity | object | No | The identity of the virtual machine scale set, if configured. - [VirtualMachineScaleSetIdentity object](#VirtualMachineScaleSetIdentity) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The sku name. | -| tier | string | No | Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** | -| capacity | integer | No | Specifies the number of virtual machines in the scale set. | - - -     -### VirtualMachineScaleSetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| upgradePolicy | object | No | The upgrade policy. - [UpgradePolicy object](#UpgradePolicy) | -| virtualMachineProfile | object | No | The virtual machine profile. - [VirtualMachineScaleSetVMProfile object](#VirtualMachineScaleSetVMProfile) | -| overProvision | boolean | No | Specifies whether the Virtual Machine Scale Set should be overprovisioned. | - - - -### VirtualMachineScaleSetIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | No | The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. - SystemAssigned | - - - -### UpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| mode | enum | No | 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. - Automatic or Manual | - - -     -### VirtualMachineScaleSetVMProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osProfile | object | No | The virtual machine scale set OS profile. - [VirtualMachineScaleSetOSProfile object](#VirtualMachineScaleSetOSProfile) | -| storageProfile | object | No | The virtual machine scale set storage profile. - [VirtualMachineScaleSetStorageProfile object](#VirtualMachineScaleSetStorageProfile) | -| networkProfile | object | No | The virtual machine scale set network profile. - [VirtualMachineScaleSetNetworkProfile object](#VirtualMachineScaleSetNetworkProfile) | -| extensionProfile | object | No | The virtual machine scale set extension profile. - [VirtualMachineScaleSetExtensionProfile object](#VirtualMachineScaleSetExtensionProfile) | - - - -### VirtualMachineScaleSetOSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerNamePrefix | string | No | 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. | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | A base-64 encoded string of custom data. | -| windowsConfiguration | object | No | The Windows Configuration of the OS profile. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | The Linux Configuration of the OS profile. - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | The List of certificates for addition to the VM. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### VirtualMachineScaleSetStorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | The image reference. - [ImageReference object](#ImageReference) | -| osDisk | object | No | The OS disk. - [VirtualMachineScaleSetOSDisk object](#VirtualMachineScaleSetOSDisk) | - - - -### VirtualMachineScaleSetNetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| networkInterfaceConfigurations | array | No | The list of network configurations. - [VirtualMachineScaleSetNetworkConfiguration object](#VirtualMachineScaleSetNetworkConfiguration) | - - - -### VirtualMachineScaleSetExtensionProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| extensions | array | No | The virtual machine scale set child extension resources. - [VirtualMachineScaleSetExtension object](#VirtualMachineScaleSetExtension) | - - - -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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. | - - - -### VirtualMachineScaleSetOSDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The disk name. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. - FromImage, Empty, Attach | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| image | object | No | The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| vhdContainers | array | No | The list of virtual hard disk container uris. - string | - - -     -### VirtualMachineScaleSetNetworkConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The network configuration name. | -| properties | object | No | [VirtualMachineScaleSetNetworkConfigurationProperties object](#VirtualMachineScaleSetNetworkConfigurationProperties) | - - - -### VirtualMachineScaleSetExtension object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | No | The name of the extension. | -| properties | object | No | [VirtualMachineScaleSetExtensionProperties object](#VirtualMachineScaleSetExtensionProperties) | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### VirtualMachineScaleSetNetworkConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Whether this is a primary NIC on a virtual machine. | -| ipConfigurations | array | Yes | The virtual machine scale set IP Configuration. - [VirtualMachineScaleSetIPConfiguration object](#VirtualMachineScaleSetIPConfiguration) | - - - -### VirtualMachineScaleSetExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | The type of the extension handler. | -| typeHandlerVersion | string | No | The type version of the extension handler. | -| autoUpgradeMinorVersion | boolean | No | Whether the extension handler should be automatically upgraded across minor versions. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | Json formatted protected settings for the extension. | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - - -     -### VirtualMachineScaleSetIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The IP configuration name. | -| properties | object | No | [VirtualMachineScaleSetIPConfigurationProperties object](#VirtualMachineScaleSetIPConfigurationProperties) | - - - -### VirtualMachineScaleSetIPConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | Yes | The subnet. - [ApiEntityReference object](#ApiEntityReference) | -| applicationGatewayBackendAddressPools | array | No | The application gateway backend address pools. - [SubResource object](#SubResource) | -| loadBalancerBackendAddressPools | array | No | The load balancer backend address pools. - [SubResource object](#SubResource) | -| loadBalancerInboundNatPools | array | No | The load balancer inbound nat pools. - [SubResource object](#SubResource) | - - - -### ApiEntityReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... | - diff --git a/test/Resource/Expected/Compute/2016-03-30/virtualMachines.md b/test/Resource/Expected/Compute/2016-03-30/virtualMachines.md deleted file mode 100644 index 637bd5c..0000000 --- a/test/Resource/Expected/Compute/2016-03-30/virtualMachines.md +++ /dev/null @@ -1,417 +0,0 @@ -# Microsoft.Compute/virtualMachines template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Compute/virtualMachines resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines", - "apiVersion": "2016-03-30", - "location": "string", - "tags": {}, - "plan": { - "name": "string", - "publisher": "string", - "product": "string", - "promotionCode": "string" - }, - "properties": { - "hardwareProfile": { - "vmSize": "string" - }, - "storageProfile": { - "imageReference": { - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "osType": "string", - "encryptionSettings": { - "diskEncryptionKey": { - "secretUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "keyEncryptionKey": { - "keyUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "enabled": "boolean" - }, - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer" - }, - "dataDisks": [ - { - "lun": "integer", - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer" - } - ] - }, - "osProfile": { - "computerName": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "string", - "properties": { - "primary": "boolean" - } - } - ] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": "boolean", - "storageUri": "string" - } - }, - "availabilitySet": { - "id": "string" - }, - "licenseType": "string" - }, - "identity": { - "type": "SystemAssigned" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachines object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines | -| apiVersion | enum | Yes | 2016-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) | -| properties | object | Yes | [VirtualMachineProperties object](#VirtualMachineProperties) | -| identity | object | No | The identity of the virtual machine, if configured. - [VirtualMachineIdentity object](#VirtualMachineIdentity) | -| resources | array | No | [extensions](./virtualMachines/extensions.md) | - - - -### Plan object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The plan ID. | -| publisher | string | No | The publisher ID. | -| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | -| promotionCode | string | No | The promotion code. | - - - -### VirtualMachineProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| hardwareProfile | object | No | Specifies the hardware settings for the virtual machine. - [HardwareProfile object](#HardwareProfile) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [StorageProfile object](#StorageProfile) | -| osProfile | object | No | Specifies the operating system settings for the virtual machine. - [OSProfile object](#OSProfile) | -| networkProfile | object | No | Specifies the network interfaces of the virtual machine. - [NetworkProfile object](#NetworkProfile) | -| diagnosticsProfile | object | No | Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - [DiagnosticsProfile object](#DiagnosticsProfile) | -| availabilitySet | object | No | Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. - [SubResource object](#SubResource) | -| licenseType | string | No | 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 | - - -     -### VirtualMachineIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | No | The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. - SystemAssigned | - - - -### HardwareProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vmSize | enum | No | 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). - Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_D15_v2, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_DS1_v2, Standard_DS2_v2, Standard_DS3_v2, Standard_DS4_v2, Standard_DS5_v2, Standard_DS11_v2, Standard_DS12_v2, Standard_DS13_v2, Standard_DS14_v2, Standard_DS15_v2, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5 | - - -     -### StorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. - [ImageReference object](#ImageReference) | -| osDisk | object | No | Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [OSDisk object](#OSDisk) | -| dataDisks | array | No | 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). - [DataDisk object](#DataDisk) | - - -     -### OSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerName | string | No | Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | 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) | -| windowsConfiguration | object | No | Specifies Windows operating system settings on the virtual machine. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | Specifies the Linux operating system settings on the virtual machine.

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

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | Specifies set of certificates that should be installed onto the virtual machine. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### NetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| networkInterfaces | array | No | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. - [NetworkInterfaceReference object](#NetworkInterfaceReference) | - - - -### DiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bootDiagnostics | object | No | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor. - [BootDiagnostics object](#BootDiagnostics) | - - -     -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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 object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| encryptionSettings | object | No | Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 - [DiskEncryptionSettings object](#DiskEncryptionSettings) | -| name | string | Yes | The disk name. | -| vhd | object | Yes | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | - - -     -### DataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | 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 | Yes | The disk name. | -| vhd | object | Yes | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | - - -     -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### NetworkInterfaceReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceReferenceProperties object](#NetworkInterfaceReferenceProperties) | - - - -### BootDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | Whether boot diagnostics should be enabled on the Virtual Machine. | -| storageUri | string | No | Uri of the storage account to use for placing the console output and screenshot. | - - - -### DiskEncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| diskEncryptionKey | object | No | Specifies the location of the disk encryption key, which is a Key Vault Secret. - [KeyVaultSecretReference object](#KeyVaultSecretReference) | -| keyEncryptionKey | object | No | Specifies the location of the key encryption key in Key Vault. - [KeyVaultKeyReference object](#KeyVaultKeyReference) | -| enabled | boolean | No | Specifies whether disk encryption should be enabled on the virtual machine. | - - - -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### NetworkInterfaceReferenceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | - - - -### KeyVaultSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| secretUrl | string | Yes | The URL referencing a secret in a Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the secret. - [SubResource object](#SubResource) | - - - -### KeyVaultKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyUrl | string | Yes | The URL referencing a key encryption key in Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the key. - [SubResource object](#SubResource) | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - diff --git a/test/Resource/Expected/Compute/2016-03-30/virtualMachines/extensions.md b/test/Resource/Expected/Compute/2016-03-30/virtualMachines/extensions.md deleted file mode 100644 index 74c5f49..0000000 --- a/test/Resource/Expected/Compute/2016-03-30/virtualMachines/extensions.md +++ /dev/null @@ -1,98 +0,0 @@ -# Microsoft.Compute/virtualMachines/extensions template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Compute/virtualMachines/extensions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines/extensions", - "apiVersion": "2016-03-30", - "location": "string", - "tags": {}, - "properties": { - "forceUpdateTag": "string", - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "string", - "type": "string", - "typeHandlerVersion": "string", - "substatuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ], - "statuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/virtualMachines/extensions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines/extensions | -| apiVersion | enum | Yes | 2016-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualMachineExtensionProperties object](#VirtualMachineExtensionProperties) | - - - -### VirtualMachineExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceUpdateTag | string | No | How the extension handler should be forced to update even if the extension configuration has not changed. | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | -| instanceView | object | No | The virtual machine extension instance view. - [VirtualMachineExtensionInstanceView object](#VirtualMachineExtensionInstanceView) | - - - -### VirtualMachineExtensionInstanceView object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The virtual machine extension name. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| substatuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | -| statuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | - - - -### InstanceViewStatus object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| code | string | No | The status code. | -| level | enum | No | The level code. - Info, Warning, Error | -| displayStatus | string | No | The short localizable label for the status. | -| message | string | No | The detailed status message, including for alerts and error messages. | -| time | string | No | The time of the status. | - diff --git a/test/Resource/Expected/Compute/2016-04-30-preview/Microsoft.Compute.json b/test/Resource/Expected/Compute/2016-04-30-preview/Microsoft.Compute.json deleted file mode 100644 index 44f7d01..0000000 --- a/test/Resource/Expected/Compute/2016-04-30-preview/Microsoft.Compute.json +++ /dev/null @@ -1,2963 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-04-30-preview/Microsoft.Compute.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Compute", - "description": "Microsoft Compute Resource Types", - "resourceDefinitions": { - "availabilitySets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-04-30-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AvailabilitySetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sku of the availability set" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/availabilitySets" - }, - "disks": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the disk within the given subscription and resource group." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/disks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-04-30-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DiskProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/disks" - }, - "images": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-04-30-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ImageProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/images" - }, - "snapshots": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the snapshot within the given subscription and resource group." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/snapshots" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-04-30-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DiskProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/snapshots" - }, - "virtualMachines": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-04-30-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the virtual machine, if configured." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachines_extensions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines" - }, - "virtualMachineScaleSets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-04-30-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set sku." - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the virtual machine scale set, if configured." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets" - }, - "virtualMachines_extensions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines/extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-04-30-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - } - }, - "definitions": { - "AdditionalUnattendContent": { - "type": "object", - "properties": { - "passName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "OobeSystem" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." - }, - "componentName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft-Windows-Shell-Setup" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." - }, - "settingName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AutoLogon", - "FirstLogonCommands" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." - }, - "content": { - "type": "string", - "description": "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." - } - }, - "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." - }, - "ApiEntityReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." - } - }, - "description": "The API entity reference." - }, - "AvailabilitySetProperties": { - "type": "object", - "properties": { - "platformUpdateDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Update Domain count." - }, - "platformFaultDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Fault Domain count." - }, - "virtualMachines": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references to all virtual machines in the availability set." - }, - "managed": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the availability set supports managed disks." - } - }, - "description": "The instance view of a resource." - }, - "BootDiagnostics": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether boot diagnostics should be enabled on the Virtual Machine." - }, - "storageUri": { - "type": "string", - "description": "Uri of the storage account to use for placing the console output and screenshot." - } - }, - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - }, - "CreationData": { - "type": "object", - "properties": { - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Empty", - "Attach", - "FromImage", - "Import", - "Copy", - "Restore" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This enumerates the possible sources of a disk's creation." - }, - "storageAccountId": { - "type": "string", - "description": "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" - }, - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageDiskReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Disk source information." - }, - "sourceUri": { - "type": "string", - "description": "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." - }, - "sourceResourceId": { - "type": "string", - "description": "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." - } - }, - "required": [ - "createOption" - ], - "description": "Data used when creating a disk." - }, - "DataDisk": { - "type": "object", - "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a data disk." - }, - "DiagnosticsProfile": { - "type": "object", - "properties": { - "bootDiagnostics": { - "oneOf": [ - { - "$ref": "#/definitions/BootDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - } - }, - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "DiskEncryptionSettings": { - "type": "object", - "properties": { - "diskEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultSecretReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." - }, - "keyEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultKeyReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the key encryption key in Key Vault." - }, - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." - } - }, - "description": "Describes a Encryption Settings for a Disk" - }, - "DiskProperties": { - "type": "object", - "properties": { - "accountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the storage account type of the disk." - }, - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Operating System type." - }, - "creationData": { - "oneOf": [ - { - "$ref": "#/definitions/CreationData" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Disk source information. CreationData information cannot be changed after the disk has been created." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Encryption settings for disk or snapshot" - } - }, - "required": [ - "creationData" - ], - "description": "Disk resource properties." - }, - "EncryptionSettings": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "diskEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultAndSecretReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key Vault Secret Url and vault id of the disk encryption key" - }, - "keyEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultAndKeyReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key Vault Key Url and vault id of the key encryption key" - } - }, - "description": "Encryption settings for disk or snapshot" - }, - "HardwareProfile": { - "type": "object", - "properties": { - "vmSize": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic_A0", - "Basic_A1", - "Basic_A2", - "Basic_A3", - "Basic_A4", - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_D15_v2", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_DS1_v2", - "Standard_DS2_v2", - "Standard_DS3_v2", - "Standard_DS4_v2", - "Standard_DS5_v2", - "Standard_DS11_v2", - "Standard_DS12_v2", - "Standard_DS13_v2", - "Standard_DS14_v2", - "Standard_DS15_v2", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the hardware settings for the virtual machine." - }, - "ImageDataDisk": { - "type": "object", - "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "snapshot": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The snapshot." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - } - }, - "required": [ - "lun" - ], - "description": "Describes a data disk." - }, - "ImageDiskReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "A relative uri containing either a Platform Imgage Repository or user image reference." - }, - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "required": [ - "id" - ], - "description": "The source image used for creating the disk." - }, - "ImageOSDisk": { - "type": "object", - "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." - }, - "osState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Generalized", - "Specialized" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The OS State." - }, - "snapshot": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The snapshot." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - } - }, - "required": [ - "osType", - "osState" - ], - "description": "Describes an Operating System disk." - }, - "ImageProperties": { - "type": "object", - "properties": { - "sourceVirtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source virtual machine from which Image is created." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ImageStorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - } - }, - "description": "Describes the properties of an Image." - }, - "ImageReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "publisher": { - "type": "string", - "description": "The image publisher." - }, - "offer": { - "type": "string", - "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." - }, - "sku": { - "type": "string", - "description": "The image SKU." - }, - "version": { - "type": "string", - "description": "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." - } - }, - "description": "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." - }, - "ImageStorageProfile": { - "type": "object", - "properties": { - "osDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ImageOSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "required": [ - "osDisk" - ], - "description": "Describes a storage profile." - }, - "InstanceViewStatus": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The status code." - }, - "level": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Info", - "Warning", - "Error" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The level code." - }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, - "message": { - "type": "string", - "description": "The detailed status message, including for alerts and error messages." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "The time of the status." - } - }, - "description": "Instance view status." - }, - "KeyVaultAndKeyReference": { - "type": "object", - "properties": { - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SourceVault" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "keyUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" - } - }, - "required": [ - "sourceVault", - "keyUrl" - ], - "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" - }, - "KeyVaultAndSecretReference": { - "type": "object", - "properties": { - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SourceVault" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "secretUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" - } - }, - "required": [ - "sourceVault", - "secretUrl" - ], - "description": "Key Vault Secret Url and vault id of the encryption key " - }, - "KeyVaultKeyReference": { - "type": "object", - "properties": { - "keyUrl": { - "type": "string", - "description": "The URL referencing a key encryption key in Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the key." - } - }, - "required": [ - "keyUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Key" - }, - "KeyVaultSecretReference": { - "type": "object", - "properties": { - "secretUrl": { - "type": "string", - "description": "The URL referencing a secret in a Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the secret." - } - }, - "required": [ - "secretUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Secret" - }, - "LinuxConfiguration": { - "type": "object", - "properties": { - "disablePasswordAuthentication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether password authentication should be disabled." - }, - "ssh": { - "oneOf": [ - { - "$ref": "#/definitions/SshConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the ssh key configuration for a Linux OS." - } - }, - "description": "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)." - }, - "ManagedDiskParameters": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "description": "The parameters of a managed disk." - }, - "NetworkInterfaceReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceReferenceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a network interface reference." - }, - "NetworkInterfaceReferenceProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - } - }, - "description": "Describes a network interface reference properties." - }, - "NetworkProfile": { - "type": "object", - "properties": { - "networkInterfaces": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." - } - }, - "description": "Specifies the network interfaces of the virtual machine." - }, - "OSDisk": { - "type": "object", - "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**." - }, - "encryptionSettings": { - "oneOf": [ - { - "$ref": "#/definitions/DiskEncryptionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "createOption" - ], - "description": "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)." - }, - "OSProfile": { - "type": "object", - "properties": { - "computerName": { - "type": "string", - "description": "Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "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)" - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies set of certificates that should be installed onto the virtual machine." - } - }, - "description": "Specifies the operating system settings for the virtual machine." - }, - "Plan": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The plan ID." - }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, - "product": { - "type": "string", - "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." - }, - "promotionCode": { - "type": "string", - "description": "The promotion code." - } - }, - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the number of virtual machines in the scale set." - } - }, - "description": "Describes a virtual machine scale set sku." - }, - "SourceVault": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" - }, - "SshConfiguration": { - "type": "object", - "properties": { - "publicKeys": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of SSH public keys used to authenticate with linux based VMs." - } - }, - "description": "SSH configuration for Linux based VMs running on Azure" - }, - "SshPublicKey": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "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" - }, - "keyData": { - "type": "string", - "description": "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)." - } - }, - "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." - }, - "StorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/OSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the storage settings for the virtual machine disks." - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - } - }, - "UpgradePolicy": { - "type": "object", - "properties": { - "mode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Automatic", - "Manual" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "description": "Describes an upgrade policy - automatic or manual." - }, - "VaultCertificate": { - "type": "object", - "properties": { - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - }, - "certificateStore": { - "type": "string", - "description": "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." - } - }, - "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." - }, - "VaultSecretGroup": { - "type": "object", - "properties": { - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." - }, - "vaultCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of key vault references in SourceVault which contain certificates." - } - }, - "description": "Describes a set of certificates which are all in the same Key Vault." - }, - "VirtualHardDisk": { - "type": "object", - "properties": { - "uri": { - "type": "string", - "description": "Specifies the virtual hard disk's uri." - } - }, - "description": "Describes the uri of a disk." - }, - "VirtualMachineExtensionInstanceView": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The virtual machine extension name." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - }, - "statuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "instanceView": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionInstanceView" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine extension instance view." - } - }, - "description": "Describes the properties of a Virtual Machine Extension." - }, - "VirtualMachineIdentity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." - } - }, - "description": "Identity for the virtual machine." - }, - "VirtualMachineProperties": { - "type": "object", - "properties": { - "hardwareProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HardwareProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/StorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/OSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machine." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the network interfaces of the virtual machine." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "availabilitySet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "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" - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "VirtualMachineScaleSetDataDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The create option." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a virtual machine scale set data disk." - }, - "VirtualMachineScaleSetExtension": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the extension." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetExtensionProfile": { - "type": "object", - "properties": { - "extensions": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set child extension resources." - } - }, - "description": "Describes a virtual machine scale set extension profile." - }, - "VirtualMachineScaleSetExtensionProperties": { - "type": "object", - "properties": { - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetIdentity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." - } - }, - "description": "Identity for the virtual machine scale set." - }, - "VirtualMachineScaleSetIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The IP configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetIPConfigurationProperties": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/ApiEntityReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The subnet." - }, - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The application gateway backend address pools." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load balancer backend address pools." - }, - "loadBalancerInboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load balancer inbound nat pools." - } - }, - "required": [ - "subnet" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration properties." - }, - "VirtualMachineScaleSetManagedDiskParameters": { - "type": "object", - "properties": { - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "description": "Describes the parameters of a ScaleSet managed disk." - }, - "VirtualMachineScaleSetNetworkConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The network configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's network configurations." - }, - "VirtualMachineScaleSetNetworkConfigurationProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether this is a primary NIC on a virtual machine." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set IP Configuration." - } - }, - "required": [ - "ipConfigurations" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetNetworkProfile": { - "type": "object", - "properties": { - "networkInterfaceConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of network configurations." - } - }, - "description": "Describes a virtual machine scale set network profile." - }, - "VirtualMachineScaleSetOSDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." - }, - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." - }, - "vhdContainers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of virtual hard disk container uris." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "createOption" - ], - "description": "Describes a virtual machine scale set operating system disk." - }, - "VirtualMachineScaleSetOSProfile": { - "type": "object", - "properties": { - "computerNamePrefix": { - "type": "string", - "description": "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." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "A base-64 encoded string of custom data." - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Windows Configuration of the OS profile." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Linux Configuration of the OS profile." - }, - "secrets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The List of certificates for addition to the VM." - } - }, - "description": "Describes a virtual machine scale set OS profile." - }, - "VirtualMachineScaleSetProperties": { - "type": "object", - "properties": { - "upgradePolicy": { - "oneOf": [ - { - "$ref": "#/definitions/UpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The upgrade policy." - }, - "virtualMachineProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine profile." - }, - "overProvision": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." - }, - "singlePlacementGroup": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set." - }, - "VirtualMachineScaleSetStorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The image reference." - }, - "osDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The OS disk." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The data disks." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "VirtualMachineScaleSetVMProfile": { - "type": "object", - "properties": { - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set OS profile." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set storage profile." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set network profile." - }, - "extensionProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set extension profile." - } - }, - "description": "Describes a virtual machine scale set virtual machine profile." - }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-04-30-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "WindowsConfiguration": { - "type": "object", - "properties": { - "provisionVMAgent": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "enableAutomaticUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether virtual machine is enabled for automatic updates." - }, - "timeZone": { - "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, - "additionalUnattendContent": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalUnattendContent" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." - }, - "winRM": { - "oneOf": [ - { - "$ref": "#/definitions/WinRMConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." - } - }, - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "WinRMConfiguration": { - "type": "object", - "properties": { - "listeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/WinRMListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of Windows Remote Management listeners" - } - }, - "description": "Describes Windows Remote Management configuration of the VM" - }, - "WinRMListener": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - } - }, - "description": "Describes Protocol and thumbprint of Windows Remote Management listener" - } - } -} diff --git a/test/Resource/Expected/Compute/2016-04-30-preview/availabilitySets.md b/test/Resource/Expected/Compute/2016-04-30-preview/availabilitySets.md deleted file mode 100644 index 8721964..0000000 --- a/test/Resource/Expected/Compute/2016-04-30-preview/availabilitySets.md +++ /dev/null @@ -1,72 +0,0 @@ -# Microsoft.Compute/availabilitySets template reference -API Version: 2016-04-30-preview -## Template format - -To create a Microsoft.Compute/availabilitySets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/availabilitySets", - "apiVersion": "2016-04-30-preview", - "location": "string", - "tags": {}, - "properties": { - "platformUpdateDomainCount": "integer", - "platformFaultDomainCount": "integer", - "virtualMachines": [ - { - "id": "string" - } - ], - "managed": "boolean" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/availabilitySets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/availabilitySets | -| apiVersion | enum | Yes | 2016-04-30-preview | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [AvailabilitySetProperties object](#AvailabilitySetProperties) | -| sku | object | No | Sku of the availability set - [Sku object](#Sku) | - - - -### AvailabilitySetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| platformUpdateDomainCount | integer | No | Update Domain count. | -| platformFaultDomainCount | integer | No | Fault Domain count. | -| virtualMachines | array | No | A list of references to all virtual machines in the availability set. - [SubResource object](#SubResource) | -| managed | boolean | No | If the availability set supports managed disks. | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The sku name. | -| tier | string | No | Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** | -| capacity | integer | No | Specifies the number of virtual machines in the scale set. | - - -     -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Compute/2016-04-30-preview/disks.md b/test/Resource/Expected/Compute/2016-04-30-preview/disks.md deleted file mode 100644 index 7565e95..0000000 --- a/test/Resource/Expected/Compute/2016-04-30-preview/disks.md +++ /dev/null @@ -1,122 +0,0 @@ -# Microsoft.Compute/disks template reference -API Version: 2016-04-30-preview -## Template format - -To create a Microsoft.Compute/disks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/disks", - "apiVersion": "2016-04-30-preview", - "location": "string", - "tags": {}, - "properties": { - "accountType": "string", - "osType": "string", - "creationData": { - "createOption": "string", - "storageAccountId": "string", - "imageReference": { - "id": "string", - "lun": "integer" - }, - "sourceUri": "string", - "sourceResourceId": "string" - }, - "diskSizeGB": "integer", - "encryptionSettings": { - "enabled": "boolean", - "diskEncryptionKey": { - "sourceVault": { - "id": "string" - }, - "secretUrl": "string" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "string" - }, - "keyUrl": "string" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/disks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the disk within the given subscription and resource group. | -| type | enum | Yes | Microsoft.Compute/disks | -| apiVersion | enum | Yes | 2016-04-30-preview | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [DiskProperties object](#DiskProperties) | - - - -### DiskProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| accountType | enum | No | the storage account type of the disk. - Standard_LRS or Premium_LRS | -| osType | enum | No | The Operating System type. - Windows or Linux | -| creationData | object | Yes | Disk source information. CreationData information cannot be changed after the disk has been created. - [CreationData object](#CreationData) | -| diskSizeGB | integer | No | 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 | object | No | Encryption settings for disk or snapshot - [EncryptionSettings object](#EncryptionSettings) | - - - -### CreationData object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| createOption | enum | Yes | This enumerates the possible sources of a disk's creation. - Empty, Attach, FromImage, Import, Copy, Restore | -| storageAccountId | string | No | 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 | -| imageReference | object | No | Disk source information. - [ImageDiskReference object](#ImageDiskReference) | -| sourceUri | string | No | 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. | -| sourceResourceId | string | No | 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. | - - - -### EncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | 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. | -| diskEncryptionKey | object | No | Key Vault Secret Url and vault id of the disk encryption key - [KeyVaultAndSecretReference object](#KeyVaultAndSecretReference) | -| keyEncryptionKey | object | No | Key Vault Key Url and vault id of the key encryption key - [KeyVaultAndKeyReference object](#KeyVaultAndKeyReference) | - - - -### ImageDiskReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | A relative uri containing either a Platform Imgage Repository or user image reference. | -| lun | integer | No | 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. | - - - -### KeyVaultAndSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | Yes | Resource id of the KeyVault containing the key or secret - [SourceVault object](#SourceVault) | -| secretUrl | string | Yes | Url pointing to a key or secret in KeyVault | - - - -### KeyVaultAndKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | Yes | Resource id of the KeyVault containing the key or secret - [SourceVault object](#SourceVault) | -| keyUrl | string | Yes | Url pointing to a key or secret in KeyVault | - - - -### SourceVault object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Compute/2016-04-30-preview/images.md b/test/Resource/Expected/Compute/2016-04-30-preview/images.md deleted file mode 100644 index 78c9db2..0000000 --- a/test/Resource/Expected/Compute/2016-04-30-preview/images.md +++ /dev/null @@ -1,112 +0,0 @@ -# Microsoft.Compute/images template reference -API Version: 2016-04-30-preview -## Template format - -To create a Microsoft.Compute/images resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/images", - "apiVersion": "2016-04-30-preview", - "location": "string", - "tags": {}, - "properties": { - "sourceVirtualMachine": { - "id": "string" - }, - "storageProfile": { - "osDisk": { - "osType": "string", - "osState": "string", - "snapshot": { - "id": "string" - }, - "managedDisk": { - "id": "string" - }, - "blobUri": "string", - "caching": "string", - "diskSizeGB": "integer" - }, - "dataDisks": [ - { - "lun": "integer", - "snapshot": { - "id": "string" - }, - "managedDisk": { - "id": "string" - }, - "blobUri": "string", - "caching": "string", - "diskSizeGB": "integer" - } - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/images object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/images | -| apiVersion | enum | Yes | 2016-04-30-preview | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [ImageProperties object](#ImageProperties) | - - - -### ImageProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVirtualMachine | object | No | The source virtual machine from which Image is created. - [SubResource object](#SubResource) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [ImageStorageProfile object](#ImageStorageProfile) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### ImageStorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osDisk | object | Yes | 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). - [ImageOSDisk object](#ImageOSDisk) | -| dataDisks | array | No | 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). - [ImageDataDisk object](#ImageDataDisk) | - - -     -### ImageOSDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | Yes | This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| osState | enum | Yes | The OS State. - Generalized or Specialized | -| snapshot | object | No | The snapshot. - [SubResource object](#SubResource) | -| managedDisk | object | No | The managedDisk. - [SubResource object](#SubResource) | -| blobUri | string | No | The Virtual Hard Disk. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| diskSizeGB | integer | No | 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 | - - -     -### ImageDataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | 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. | -| snapshot | object | No | The snapshot. - [SubResource object](#SubResource) | -| managedDisk | object | No | The managedDisk. - [SubResource object](#SubResource) | -| blobUri | string | No | The Virtual Hard Disk. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| diskSizeGB | integer | No | 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 | - diff --git a/test/Resource/Expected/Compute/2016-04-30-preview/snapshots.md b/test/Resource/Expected/Compute/2016-04-30-preview/snapshots.md deleted file mode 100644 index 3954ed5..0000000 --- a/test/Resource/Expected/Compute/2016-04-30-preview/snapshots.md +++ /dev/null @@ -1,122 +0,0 @@ -# Microsoft.Compute/snapshots template reference -API Version: 2016-04-30-preview -## Template format - -To create a Microsoft.Compute/snapshots resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/snapshots", - "apiVersion": "2016-04-30-preview", - "location": "string", - "tags": {}, - "properties": { - "accountType": "string", - "osType": "string", - "creationData": { - "createOption": "string", - "storageAccountId": "string", - "imageReference": { - "id": "string", - "lun": "integer" - }, - "sourceUri": "string", - "sourceResourceId": "string" - }, - "diskSizeGB": "integer", - "encryptionSettings": { - "enabled": "boolean", - "diskEncryptionKey": { - "sourceVault": { - "id": "string" - }, - "secretUrl": "string" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "string" - }, - "keyUrl": "string" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/snapshots object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the snapshot within the given subscription and resource group. | -| type | enum | Yes | Microsoft.Compute/snapshots | -| apiVersion | enum | Yes | 2016-04-30-preview | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [DiskProperties object](#DiskProperties) | - - - -### DiskProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| accountType | enum | No | the storage account type of the disk. - Standard_LRS or Premium_LRS | -| osType | enum | No | The Operating System type. - Windows or Linux | -| creationData | object | Yes | Disk source information. CreationData information cannot be changed after the disk has been created. - [CreationData object](#CreationData) | -| diskSizeGB | integer | No | 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 | object | No | Encryption settings for disk or snapshot - [EncryptionSettings object](#EncryptionSettings) | - - - -### CreationData object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| createOption | enum | Yes | This enumerates the possible sources of a disk's creation. - Empty, Attach, FromImage, Import, Copy, Restore | -| storageAccountId | string | No | 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 | -| imageReference | object | No | Disk source information. - [ImageDiskReference object](#ImageDiskReference) | -| sourceUri | string | No | 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. | -| sourceResourceId | string | No | 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. | - - - -### EncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | 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. | -| diskEncryptionKey | object | No | Key Vault Secret Url and vault id of the disk encryption key - [KeyVaultAndSecretReference object](#KeyVaultAndSecretReference) | -| keyEncryptionKey | object | No | Key Vault Key Url and vault id of the key encryption key - [KeyVaultAndKeyReference object](#KeyVaultAndKeyReference) | - - - -### ImageDiskReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | A relative uri containing either a Platform Imgage Repository or user image reference. | -| lun | integer | No | 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. | - - - -### KeyVaultAndSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | Yes | Resource id of the KeyVault containing the key or secret - [SourceVault object](#SourceVault) | -| secretUrl | string | Yes | Url pointing to a key or secret in KeyVault | - - - -### KeyVaultAndKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | Yes | Resource id of the KeyVault containing the key or secret - [SourceVault object](#SourceVault) | -| keyUrl | string | Yes | Url pointing to a key or secret in KeyVault | - - - -### SourceVault object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Compute/2016-04-30-preview/virtualMachineScaleSets.md b/test/Resource/Expected/Compute/2016-04-30-preview/virtualMachineScaleSets.md deleted file mode 100644 index c40bf45..0000000 --- a/test/Resource/Expected/Compute/2016-04-30-preview/virtualMachineScaleSets.md +++ /dev/null @@ -1,479 +0,0 @@ -# Microsoft.Compute/virtualMachineScaleSets template reference -API Version: 2016-04-30-preview -## Template format - -To create a Microsoft.Compute/virtualMachineScaleSets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "apiVersion": "2016-04-30-preview", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "plan": { - "name": "string", - "publisher": "string", - "product": "string", - "promotionCode": "string" - }, - "properties": { - "upgradePolicy": { - "mode": "string" - }, - "virtualMachineProfile": { - "osProfile": { - "computerNamePrefix": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "storageProfile": { - "imageReference": { - "id": "string", - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "name": "string", - "caching": "string", - "createOption": "string", - "osType": "string", - "image": { - "uri": "string" - }, - "vhdContainers": [ - "string" - ], - "managedDisk": { - "storageAccountType": "string" - } - }, - "dataDisks": [ - { - "name": "string", - "lun": "integer", - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "storageAccountType": "string" - } - } - ] - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "primary": "boolean", - "ipConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "subnet": { - "id": "string" - }, - "applicationGatewayBackendAddressPools": [ - { - "id": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string" - } - ], - "loadBalancerInboundNatPools": [ - { - "id": "string" - } - ] - } - } - ] - } - } - ] - }, - "extensionProfile": { - "extensions": [ - { - "name": "string", - "properties": { - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {} - } - } - ] - } - }, - "overProvision": "boolean", - "singlePlacementGroup": "boolean" - }, - "identity": { - "type": "SystemAssigned" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachineScaleSets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachineScaleSets | -| apiVersion | enum | Yes | 2016-04-30-preview | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | The virtual machine scale set sku. - [Sku object](#Sku) | -| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) | -| properties | object | Yes | [VirtualMachineScaleSetProperties object](#VirtualMachineScaleSetProperties) | -| identity | object | No | The identity of the virtual machine scale set, if configured. - [VirtualMachineScaleSetIdentity object](#VirtualMachineScaleSetIdentity) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The sku name. | -| tier | string | No | Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** | -| capacity | integer | No | Specifies the number of virtual machines in the scale set. | - - -     -### Plan object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The plan ID. | -| publisher | string | No | The publisher ID. | -| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | -| promotionCode | string | No | The promotion code. | - - - -### VirtualMachineScaleSetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| upgradePolicy | object | No | The upgrade policy. - [UpgradePolicy object](#UpgradePolicy) | -| virtualMachineProfile | object | No | The virtual machine profile. - [VirtualMachineScaleSetVMProfile object](#VirtualMachineScaleSetVMProfile) | -| overProvision | boolean | No | Specifies whether the Virtual Machine Scale Set should be overprovisioned. | -| singlePlacementGroup | boolean | No | When true this limits the scale set to a single placement group, of max size 100 virtual machines. | - - - -### VirtualMachineScaleSetIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | No | The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. - SystemAssigned | - - - -### UpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| mode | enum | No | 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. - Automatic or Manual | - - -     -### VirtualMachineScaleSetVMProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osProfile | object | No | The virtual machine scale set OS profile. - [VirtualMachineScaleSetOSProfile object](#VirtualMachineScaleSetOSProfile) | -| storageProfile | object | No | The virtual machine scale set storage profile. - [VirtualMachineScaleSetStorageProfile object](#VirtualMachineScaleSetStorageProfile) | -| networkProfile | object | No | The virtual machine scale set network profile. - [VirtualMachineScaleSetNetworkProfile object](#VirtualMachineScaleSetNetworkProfile) | -| extensionProfile | object | No | The virtual machine scale set extension profile. - [VirtualMachineScaleSetExtensionProfile object](#VirtualMachineScaleSetExtensionProfile) | - - - -### VirtualMachineScaleSetOSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerNamePrefix | string | No | 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. | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | A base-64 encoded string of custom data. | -| windowsConfiguration | object | No | The Windows Configuration of the OS profile. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | The Linux Configuration of the OS profile. - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | The List of certificates for addition to the VM. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### VirtualMachineScaleSetStorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | The image reference. - [ImageReference object](#ImageReference) | -| osDisk | object | No | The OS disk. - [VirtualMachineScaleSetOSDisk object](#VirtualMachineScaleSetOSDisk) | -| dataDisks | array | No | The data disks. - [VirtualMachineScaleSetDataDisk object](#VirtualMachineScaleSetDataDisk) | - - - -### VirtualMachineScaleSetNetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| networkInterfaceConfigurations | array | No | The list of network configurations. - [VirtualMachineScaleSetNetworkConfiguration object](#VirtualMachineScaleSetNetworkConfiguration) | - - - -### VirtualMachineScaleSetExtensionProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| extensions | array | No | The virtual machine scale set child extension resources. - [VirtualMachineScaleSetExtension object](#VirtualMachineScaleSetExtension) | - - - -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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. | - - - -### VirtualMachineScaleSetOSDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The disk name. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. - FromImage, Empty, Attach | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| image | object | No | The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| vhdContainers | array | No | The list of virtual hard disk container uris. - string | -| managedDisk | object | No | The managed disk parameters. - [VirtualMachineScaleSetManagedDiskParameters object](#VirtualMachineScaleSetManagedDiskParameters) | - - -     -### VirtualMachineScaleSetDataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The disk name. | -| lun | integer | Yes | 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. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | The create option. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [VirtualMachineScaleSetManagedDiskParameters object](#VirtualMachineScaleSetManagedDiskParameters) | - - -     -### VirtualMachineScaleSetNetworkConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The network configuration name. | -| properties | object | No | [VirtualMachineScaleSetNetworkConfigurationProperties object](#VirtualMachineScaleSetNetworkConfigurationProperties) | - - - -### VirtualMachineScaleSetExtension object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the extension. | -| properties | object | No | [VirtualMachineScaleSetExtensionProperties object](#VirtualMachineScaleSetExtensionProperties) | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### VirtualMachineScaleSetManagedDiskParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - - - -### VirtualMachineScaleSetNetworkConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Whether this is a primary NIC on a virtual machine. | -| ipConfigurations | array | Yes | The virtual machine scale set IP Configuration. - [VirtualMachineScaleSetIPConfiguration object](#VirtualMachineScaleSetIPConfiguration) | - - - -### VirtualMachineScaleSetExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - - -     -### VirtualMachineScaleSetIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The IP configuration name. | -| properties | object | No | [VirtualMachineScaleSetIPConfigurationProperties object](#VirtualMachineScaleSetIPConfigurationProperties) | - - - -### VirtualMachineScaleSetIPConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | Yes | The subnet. - [ApiEntityReference object](#ApiEntityReference) | -| applicationGatewayBackendAddressPools | array | No | The application gateway backend address pools. - [SubResource object](#SubResource) | -| loadBalancerBackendAddressPools | array | No | The load balancer backend address pools. - [SubResource object](#SubResource) | -| loadBalancerInboundNatPools | array | No | The load balancer inbound nat pools. - [SubResource object](#SubResource) | - - - -### ApiEntityReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... | - diff --git a/test/Resource/Expected/Compute/2016-04-30-preview/virtualMachines.md b/test/Resource/Expected/Compute/2016-04-30-preview/virtualMachines.md deleted file mode 100644 index 30d2cb7..0000000 --- a/test/Resource/Expected/Compute/2016-04-30-preview/virtualMachines.md +++ /dev/null @@ -1,437 +0,0 @@ -# Microsoft.Compute/virtualMachines template reference -API Version: 2016-04-30-preview -## Template format - -To create a Microsoft.Compute/virtualMachines resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines", - "apiVersion": "2016-04-30-preview", - "location": "string", - "tags": {}, - "plan": { - "name": "string", - "publisher": "string", - "product": "string", - "promotionCode": "string" - }, - "properties": { - "hardwareProfile": { - "vmSize": "string" - }, - "storageProfile": { - "imageReference": { - "id": "string", - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "osType": "string", - "encryptionSettings": { - "diskEncryptionKey": { - "secretUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "keyEncryptionKey": { - "keyUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "enabled": "boolean" - }, - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "id": "string", - "storageAccountType": "string" - } - }, - "dataDisks": [ - { - "lun": "integer", - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "id": "string", - "storageAccountType": "string" - } - } - ] - }, - "osProfile": { - "computerName": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "string", - "properties": { - "primary": "boolean" - } - } - ] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": "boolean", - "storageUri": "string" - } - }, - "availabilitySet": { - "id": "string" - }, - "licenseType": "string" - }, - "identity": { - "type": "SystemAssigned" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachines object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines | -| apiVersion | enum | Yes | 2016-04-30-preview | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) | -| properties | object | Yes | [VirtualMachineProperties object](#VirtualMachineProperties) | -| identity | object | No | The identity of the virtual machine, if configured. - [VirtualMachineIdentity object](#VirtualMachineIdentity) | -| resources | array | No | [extensions](./virtualMachines/extensions.md) | - - - -### Plan object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The plan ID. | -| publisher | string | No | The publisher ID. | -| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | -| promotionCode | string | No | The promotion code. | - - - -### VirtualMachineProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| hardwareProfile | object | No | Specifies the hardware settings for the virtual machine. - [HardwareProfile object](#HardwareProfile) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [StorageProfile object](#StorageProfile) | -| osProfile | object | No | Specifies the operating system settings for the virtual machine. - [OSProfile object](#OSProfile) | -| networkProfile | object | No | Specifies the network interfaces of the virtual machine. - [NetworkProfile object](#NetworkProfile) | -| diagnosticsProfile | object | No | Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - [DiagnosticsProfile object](#DiagnosticsProfile) | -| availabilitySet | object | No | Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. - [SubResource object](#SubResource) | -| licenseType | string | No | 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 | - - -     -### VirtualMachineIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | No | The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. - SystemAssigned | - - - -### HardwareProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vmSize | enum | No | 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). - Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_D15_v2, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_DS1_v2, Standard_DS2_v2, Standard_DS3_v2, Standard_DS4_v2, Standard_DS5_v2, Standard_DS11_v2, Standard_DS12_v2, Standard_DS13_v2, Standard_DS14_v2, Standard_DS15_v2, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5 | - - -     -### StorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. - [ImageReference object](#ImageReference) | -| osDisk | object | No | Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [OSDisk object](#OSDisk) | -| dataDisks | array | No | 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). - [DataDisk object](#DataDisk) | - - -     -### OSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerName | string | No | Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | 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) | -| windowsConfiguration | object | No | Specifies Windows operating system settings on the virtual machine. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | Specifies the Linux operating system settings on the virtual machine.

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

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | Specifies set of certificates that should be installed onto the virtual machine. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### NetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| networkInterfaces | array | No | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. - [NetworkInterfaceReference object](#NetworkInterfaceReference) | - - - -### DiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bootDiagnostics | object | No | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor. - [BootDiagnostics object](#BootDiagnostics) | - - -     -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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 object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| encryptionSettings | object | No | Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 - [DiskEncryptionSettings object](#DiskEncryptionSettings) | -| name | string | No | The disk name. | -| vhd | object | No | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [ManagedDiskParameters object](#ManagedDiskParameters) | - - -     -### DataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | 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 | No | The disk name. | -| vhd | object | No | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [ManagedDiskParameters object](#ManagedDiskParameters) | - - -     -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### NetworkInterfaceReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceReferenceProperties object](#NetworkInterfaceReferenceProperties) | - - - -### BootDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | Whether boot diagnostics should be enabled on the Virtual Machine. | -| storageUri | string | No | Uri of the storage account to use for placing the console output and screenshot. | - - - -### DiskEncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| diskEncryptionKey | object | No | Specifies the location of the disk encryption key, which is a Key Vault Secret. - [KeyVaultSecretReference object](#KeyVaultSecretReference) | -| keyEncryptionKey | object | No | Specifies the location of the key encryption key in Key Vault. - [KeyVaultKeyReference object](#KeyVaultKeyReference) | -| enabled | boolean | No | Specifies whether disk encryption should be enabled on the virtual machine. | - - - -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### ManagedDiskParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### NetworkInterfaceReferenceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | - - - -### KeyVaultSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| secretUrl | string | Yes | The URL referencing a secret in a Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the secret. - [SubResource object](#SubResource) | - - - -### KeyVaultKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyUrl | string | Yes | The URL referencing a key encryption key in Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the key. - [SubResource object](#SubResource) | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - diff --git a/test/Resource/Expected/Compute/2016-04-30-preview/virtualMachines/extensions.md b/test/Resource/Expected/Compute/2016-04-30-preview/virtualMachines/extensions.md deleted file mode 100644 index bf9bdc7..0000000 --- a/test/Resource/Expected/Compute/2016-04-30-preview/virtualMachines/extensions.md +++ /dev/null @@ -1,98 +0,0 @@ -# Microsoft.Compute/virtualMachines/extensions template reference -API Version: 2016-04-30-preview -## Template format - -To create a Microsoft.Compute/virtualMachines/extensions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines/extensions", - "apiVersion": "2016-04-30-preview", - "location": "string", - "tags": {}, - "properties": { - "forceUpdateTag": "string", - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "string", - "type": "string", - "typeHandlerVersion": "string", - "substatuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ], - "statuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/virtualMachines/extensions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines/extensions | -| apiVersion | enum | Yes | 2016-04-30-preview | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualMachineExtensionProperties object](#VirtualMachineExtensionProperties) | - - - -### VirtualMachineExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceUpdateTag | string | No | How the extension handler should be forced to update even if the extension configuration has not changed. | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | -| instanceView | object | No | The virtual machine extension instance view. - [VirtualMachineExtensionInstanceView object](#VirtualMachineExtensionInstanceView) | - - - -### VirtualMachineExtensionInstanceView object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The virtual machine extension name. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| substatuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | -| statuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | - - - -### InstanceViewStatus object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| code | string | No | The status code. | -| level | enum | No | The level code. - Info, Warning, Error | -| displayStatus | string | No | The short localizable label for the status. | -| message | string | No | The detailed status message, including for alerts and error messages. | -| time | string | No | The time of the status. | - diff --git a/test/Resource/Expected/Compute/2017-01-31/Microsoft.ContainerService.json b/test/Resource/Expected/Compute/2017-01-31/Microsoft.ContainerService.json deleted file mode 100644 index 82ad231..0000000 --- a/test/Resource/Expected/Compute/2017-01-31/Microsoft.ContainerService.json +++ /dev/null @@ -1,487 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-01-31/Microsoft.ContainerService.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.ContainerService", - "description": "Microsoft ContainerService Resource Types", - "resourceDefinitions": { - "containerServices": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerService/containerServices" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-31" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerService/containerServices" - } - }, - "definitions": { - "ContainerServiceAgentPoolProfile": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Unique name of the agent pool profile in the context of the subscription and resource group." - }, - "count": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": "1" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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. " - }, - "vmSize": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Size of agent VMs." - }, - "dnsPrefix": { - "type": "string", - "description": "DNS prefix to be used to create the FQDN for the agent pool." - } - }, - "required": [ - "name", - "count", - "vmSize", - "dnsPrefix" - ], - "description": "Profile for the container service agent pool." - }, - "ContainerServiceCustomProfile": { - "type": "object", - "properties": { - "orchestrator": { - "type": "string", - "description": "The name of the custom orchestrator to use." - } - }, - "required": [ - "orchestrator" - ], - "description": "Properties to configure a custom container service cluster." - }, - "ContainerServiceDiagnosticsProfile": { - "type": "object", - "properties": { - "vmDiagnostics": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceVMDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Profile for the container service VM diagnostic agent." - } - }, - "required": [ - "vmDiagnostics" - ] - }, - "ContainerServiceLinuxProfile": { - "type": "object", - "properties": { - "adminUsername": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-z][a-z0-9_-]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The administrator username to use for Linux VMs." - }, - "ssh": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceSshConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ssh key configuration for Linux VMs." - } - }, - "required": [ - "adminUsername", - "ssh" - ], - "description": "Profile for Linux VMs in the container service cluster." - }, - "ContainerServiceMasterProfile": { - "type": "object", - "properties": { - "count": { - "oneOf": [ - { - "type": "integer", - "default": "1" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1." - }, - "dnsPrefix": { - "type": "string", - "description": "DNS prefix to be used to create the FQDN for master." - } - }, - "required": [ - "dnsPrefix" - ], - "description": "Profile for the container service master." - }, - "ContainerServiceOrchestratorProfile": { - "type": "object", - "properties": { - "orchestratorType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Swarm", - "DCOS", - "Custom", - "Kubernetes" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom." - } - }, - "required": [ - "orchestratorType" - ], - "description": "Profile for the container service orchestrator." - }, - "ContainerServiceProperties": { - "type": "object", - "properties": { - "orchestratorProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceOrchestratorProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the orchestrator." - }, - "customProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceCustomProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties for custom clusters." - }, - "servicePrincipalProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceServicePrincipalProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties for cluster service principals." - }, - "masterProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceMasterProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of master agents." - }, - "agentPoolProfiles": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ContainerServiceAgentPoolProfile" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the agent pool." - }, - "windowsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceWindowsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of Windows VMs." - }, - "linuxProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceLinuxProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of Linux VMs." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ContainerServiceDiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the diagnostic agent." - } - }, - "required": [ - "masterProfile", - "agentPoolProfiles", - "linuxProfile" - ], - "description": "Properties of the container service." - }, - "ContainerServiceServicePrincipalProfile": { - "type": "object", - "properties": { - "clientId": { - "type": "string", - "description": "The ID for the service principal." - }, - "secret": { - "type": "string", - "description": "The secret password associated with the service principal." - } - }, - "required": [ - "clientId", - "secret" - ], - "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." - }, - "ContainerServiceSshConfiguration": { - "type": "object", - "properties": { - "publicKeys": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ContainerServiceSshPublicKey" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the list of SSH public keys used to authenticate with Linux-based VMs." - } - }, - "required": [ - "publicKeys" - ], - "description": "SSH configuration for Linux-based VMs running on Azure." - }, - "ContainerServiceSshPublicKey": { - "type": "object", - "properties": { - "keyData": { - "type": "string", - "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." - } - }, - "required": [ - "keyData" - ], - "description": "Contains information about SSH certificate public key data." - }, - "ContainerServiceVMDiagnostics": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the VM diagnostic agent is provisioned on the VM." - } - }, - "required": [ - "enabled" - ], - "description": "Profile for diagnostics on the container service VMs." - }, - "ContainerServiceWindowsProfile": { - "type": "object", - "properties": { - "adminUsername": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The administrator username to use for Windows VMs." - }, - "adminPassword": { - "oneOf": [ - { - "type": "string", - "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\\^&\\*\\(\\)])[a-zA-Z\\d!@#$%\\^&\\*\\(\\)]{12,123}$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The administrator password to use for Windows VMs." - } - }, - "required": [ - "adminUsername", - "adminPassword" - ], - "description": "Profile for Windows VMs in the container service cluster." - } - } -} diff --git a/test/Resource/Expected/Compute/2017-01-31/containerServices.md b/test/Resource/Expected/Compute/2017-01-31/containerServices.md deleted file mode 100644 index 82d5c07..0000000 --- a/test/Resource/Expected/Compute/2017-01-31/containerServices.md +++ /dev/null @@ -1,171 +0,0 @@ -# Microsoft.ContainerService/containerServices template reference -API Version: 2017-01-31 -## Template format - -To create a Microsoft.ContainerService/containerServices resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerService/containerServices", - "apiVersion": "2017-01-31", - "location": "string", - "tags": {}, - "properties": { - "orchestratorProfile": { - "orchestratorType": "string" - }, - "customProfile": { - "orchestrator": "string" - }, - "servicePrincipalProfile": { - "clientId": "string", - "secret": "string" - }, - "masterProfile": { - "count": "integer", - "dnsPrefix": "string" - }, - "agentPoolProfiles": [ - { - "name": "string", - "count": "integer", - "vmSize": "string", - "dnsPrefix": "string" - } - ], - "windowsProfile": { - "adminUsername": "string", - "adminPassword": "string" - }, - "linuxProfile": { - "adminUsername": "string", - "ssh": { - "publicKeys": [ - { - "keyData": "string" - } - ] - } - }, - "diagnosticsProfile": { - "vmDiagnostics": { - "enabled": "boolean" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerService/containerServices object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.ContainerService/containerServices | -| apiVersion | enum | Yes | 2017-01-31 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [ContainerServiceProperties object](#ContainerServiceProperties) | - - - -### ContainerServiceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| orchestratorProfile | object | No | Properties of the orchestrator. - [ContainerServiceOrchestratorProfile object](#ContainerServiceOrchestratorProfile) | -| customProfile | object | No | Properties for custom clusters. - [ContainerServiceCustomProfile object](#ContainerServiceCustomProfile) | -| servicePrincipalProfile | object | No | Properties for cluster service principals. - [ContainerServiceServicePrincipalProfile object](#ContainerServiceServicePrincipalProfile) | -| masterProfile | object | Yes | Properties of master agents. - [ContainerServiceMasterProfile object](#ContainerServiceMasterProfile) | -| agentPoolProfiles | array | Yes | Properties of the agent pool. - [ContainerServiceAgentPoolProfile object](#ContainerServiceAgentPoolProfile) | -| windowsProfile | object | No | Properties of Windows VMs. - [ContainerServiceWindowsProfile object](#ContainerServiceWindowsProfile) | -| linuxProfile | object | Yes | Properties of Linux VMs. - [ContainerServiceLinuxProfile object](#ContainerServiceLinuxProfile) | -| diagnosticsProfile | object | No | Properties of the diagnostic agent. - [ContainerServiceDiagnosticsProfile object](#ContainerServiceDiagnosticsProfile) | - - - -### ContainerServiceOrchestratorProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| orchestratorType | enum | Yes | The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom. - Swarm, DCOS, Custom, Kubernetes | - - - -### ContainerServiceCustomProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| orchestrator | string | Yes | The name of the custom orchestrator to use. | - - - -### ContainerServiceServicePrincipalProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| clientId | string | Yes | The ID for the service principal. | -| secret | string | Yes | The secret password associated with the service principal. | - - - -### ContainerServiceMasterProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| count | integer | No | Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. | -| dnsPrefix | string | Yes | DNS prefix to be used to create the FQDN for master. | - - - -### ContainerServiceAgentPoolProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Unique name of the agent pool profile in the context of the subscription and resource group. | -| count | integer | Yes | 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. | -| vmSize | enum | Yes | Size of agent VMs. - Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5 | -| dnsPrefix | string | Yes | DNS prefix to be used to create the FQDN for the agent pool. | - - - -### ContainerServiceWindowsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUsername | string | Yes | The administrator username to use for Windows VMs. | -| adminPassword | string | Yes | The administrator password to use for Windows VMs. | - - - -### ContainerServiceLinuxProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUsername | string | Yes | The administrator username to use for Linux VMs. | -| ssh | object | Yes | The ssh key configuration for Linux VMs. - [ContainerServiceSshConfiguration object](#ContainerServiceSshConfiguration) | - - - -### ContainerServiceDiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vmDiagnostics | object | Yes | Profile for the container service VM diagnostic agent. - [ContainerServiceVMDiagnostics object](#ContainerServiceVMDiagnostics) | - - - -### ContainerServiceSshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | Yes | the list of SSH public keys used to authenticate with Linux-based VMs. - [ContainerServiceSshPublicKey object](#ContainerServiceSshPublicKey) | - - - -### ContainerServiceVMDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether the VM diagnostic agent is provisioned on the VM. | - - - -### ContainerServiceSshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyData | string | Yes | Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. | - diff --git a/test/Resource/Expected/Compute/2017-03-30/Microsoft.Compute.json b/test/Resource/Expected/Compute/2017-03-30/Microsoft.Compute.json deleted file mode 100644 index 7e5bccc..0000000 --- a/test/Resource/Expected/Compute/2017-03-30/Microsoft.Compute.json +++ /dev/null @@ -1,3420 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-03-30/Microsoft.Compute.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Compute", - "description": "Microsoft Compute Resource Types", - "resourceDefinitions": { - "availabilitySets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AvailabilitySetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sku of the availability set" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/availabilitySets" - }, - "disks": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the disk within the given subscription and resource group." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/disks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/DiskSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Logical zone list for Disk." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DiskProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/disks" - }, - "images": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ImageProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/images" - }, - "snapshots": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the snapshot within the given subscription and resource group." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/snapshots" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/DiskSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DiskProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/snapshots" - }, - "virtualMachines": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the virtual machine, if configured." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachines_extensions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines" - }, - "virtualMachineScaleSets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set sku." - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the virtual machine scale set, if configured." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets" - }, - "virtualMachineScaleSets_extensions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets/extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" - }, - "virtualMachines_extensions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines/extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - } - }, - "definitions": { - "AdditionalUnattendContent": { - "type": "object", - "properties": { - "passName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "OobeSystem" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." - }, - "componentName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft-Windows-Shell-Setup" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." - }, - "settingName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AutoLogon", - "FirstLogonCommands" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." - }, - "content": { - "type": "string", - "description": "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." - } - }, - "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." - }, - "ApiEntityReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." - } - }, - "description": "The API entity reference." - }, - "AvailabilitySetProperties": { - "type": "object", - "properties": { - "platformUpdateDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Update Domain count." - }, - "platformFaultDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Fault Domain count." - }, - "virtualMachines": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references to all virtual machines in the availability set." - } - }, - "description": "The instance view of a resource." - }, - "BootDiagnostics": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether boot diagnostics should be enabled on the Virtual Machine." - }, - "storageUri": { - "type": "string", - "description": "Uri of the storage account to use for placing the console output and screenshot." - } - }, - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - }, - "CreationData": { - "type": "object", - "properties": { - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Empty", - "Attach", - "FromImage", - "Import", - "Copy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This enumerates the possible sources of a disk's creation." - }, - "storageAccountId": { - "type": "string", - "description": "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" - }, - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageDiskReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Disk source information." - }, - "sourceUri": { - "type": "string", - "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." - }, - "sourceResourceId": { - "type": "string", - "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." - } - }, - "required": [ - "createOption" - ], - "description": "Data used when creating a disk." - }, - "DataDisk": { - "type": "object", - "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a data disk." - }, - "DiagnosticsProfile": { - "type": "object", - "properties": { - "bootDiagnostics": { - "oneOf": [ - { - "$ref": "#/definitions/BootDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - } - }, - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "DiskEncryptionSettings": { - "type": "object", - "properties": { - "diskEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultSecretReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." - }, - "keyEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultKeyReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the key encryption key in Key Vault." - }, - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." - } - }, - "description": "Describes a Encryption Settings for a Disk" - }, - "DiskProperties": { - "type": "object", - "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Operating System type." - }, - "creationData": { - "oneOf": [ - { - "$ref": "#/definitions/CreationData" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Disk source information. CreationData information cannot be changed after the disk has been created." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Encryption settings for disk or snapshot" - } - }, - "required": [ - "creationData" - ], - "description": "Disk resource properties." - }, - "DiskSku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sku name." - } - }, - "description": "The disks and snapshots sku name. Can be Standard_LRS or Premium_LRS." - }, - "EncryptionSettings": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "diskEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultAndSecretReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key Vault Secret Url and vault id of the disk encryption key" - }, - "keyEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultAndKeyReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key Vault Key Url and vault id of the key encryption key" - } - }, - "description": "Encryption settings for disk or snapshot" - }, - "HardwareProfile": { - "type": "object", - "properties": { - "vmSize": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic_A0", - "Basic_A1", - "Basic_A2", - "Basic_A3", - "Basic_A4", - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_A1_v2", - "Standard_A2_v2", - "Standard_A4_v2", - "Standard_A8_v2", - "Standard_A2m_v2", - "Standard_A4m_v2", - "Standard_A8m_v2", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_D15_v2", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_DS1_v2", - "Standard_DS2_v2", - "Standard_DS3_v2", - "Standard_DS4_v2", - "Standard_DS5_v2", - "Standard_DS11_v2", - "Standard_DS12_v2", - "Standard_DS13_v2", - "Standard_DS14_v2", - "Standard_DS15_v2", - "Standard_F1", - "Standard_F2", - "Standard_F4", - "Standard_F8", - "Standard_F16", - "Standard_F1s", - "Standard_F2s", - "Standard_F4s", - "Standard_F8s", - "Standard_F16s", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5", - "Standard_H8", - "Standard_H16", - "Standard_H8m", - "Standard_H16m", - "Standard_H16r", - "Standard_H16mr", - "Standard_L4s", - "Standard_L8s", - "Standard_L16s", - "Standard_L32s", - "Standard_NC6", - "Standard_NC12", - "Standard_NC24", - "Standard_NC24r", - "Standard_NV6", - "Standard_NV12", - "Standard_NV24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the hardware settings for the virtual machine." - }, - "ImageDataDisk": { - "type": "object", - "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "snapshot": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The snapshot." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "required": [ - "lun" - ], - "description": "Describes a data disk." - }, - "ImageDiskReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "A relative uri containing either a Platform Imgage Repository or user image reference." - }, - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "required": [ - "id" - ], - "description": "The source image used for creating the disk." - }, - "ImageOSDisk": { - "type": "object", - "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." - }, - "osState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Generalized", - "Specialized" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The OS State." - }, - "snapshot": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The snapshot." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "required": [ - "osType", - "osState" - ], - "description": "Describes an Operating System disk." - }, - "ImageProperties": { - "type": "object", - "properties": { - "sourceVirtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source virtual machine from which Image is created." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ImageStorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - } - }, - "description": "Describes the properties of an Image." - }, - "ImageReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "publisher": { - "type": "string", - "description": "The image publisher." - }, - "offer": { - "type": "string", - "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." - }, - "sku": { - "type": "string", - "description": "The image SKU." - }, - "version": { - "type": "string", - "description": "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." - } - }, - "description": "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." - }, - "ImageStorageProfile": { - "type": "object", - "properties": { - "osDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ImageOSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "required": [ - "osDisk" - ], - "description": "Describes a storage profile." - }, - "InstanceViewStatus": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The status code." - }, - "level": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Info", - "Warning", - "Error" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The level code." - }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, - "message": { - "type": "string", - "description": "The detailed status message, including for alerts and error messages." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "The time of the status." - } - }, - "description": "Instance view status." - }, - "KeyVaultAndKeyReference": { - "type": "object", - "properties": { - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SourceVault" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "keyUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" - } - }, - "required": [ - "sourceVault", - "keyUrl" - ], - "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" - }, - "KeyVaultAndSecretReference": { - "type": "object", - "properties": { - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SourceVault" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "secretUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" - } - }, - "required": [ - "sourceVault", - "secretUrl" - ], - "description": "Key Vault Secret Url and vault id of the encryption key " - }, - "KeyVaultKeyReference": { - "type": "object", - "properties": { - "keyUrl": { - "type": "string", - "description": "The URL referencing a key encryption key in Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the key." - } - }, - "required": [ - "keyUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Key" - }, - "KeyVaultSecretReference": { - "type": "object", - "properties": { - "secretUrl": { - "type": "string", - "description": "The URL referencing a secret in a Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the secret." - } - }, - "required": [ - "secretUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Secret" - }, - "LinuxConfiguration": { - "type": "object", - "properties": { - "disablePasswordAuthentication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether password authentication should be disabled." - }, - "ssh": { - "oneOf": [ - { - "$ref": "#/definitions/SshConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the ssh key configuration for a Linux OS." - } - }, - "description": "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)." - }, - "ManagedDiskParameters": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "description": "The parameters of a managed disk." - }, - "NetworkInterfaceReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceReferenceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a network interface reference." - }, - "NetworkInterfaceReferenceProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - } - }, - "description": "Describes a network interface reference properties." - }, - "NetworkProfile": { - "type": "object", - "properties": { - "networkInterfaces": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." - } - }, - "description": "Specifies the network interfaces of the virtual machine." - }, - "OSDisk": { - "type": "object", - "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**." - }, - "encryptionSettings": { - "oneOf": [ - { - "$ref": "#/definitions/DiskEncryptionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "createOption" - ], - "description": "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)." - }, - "OSProfile": { - "type": "object", - "properties": { - "computerName": { - "type": "string", - "description": "Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "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)" - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies set of certificates that should be installed onto the virtual machine." - } - }, - "description": "Specifies the operating system settings for the virtual machine." - }, - "Plan": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The plan ID." - }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, - "product": { - "type": "string", - "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." - }, - "promotionCode": { - "type": "string", - "description": "The promotion code." - } - }, - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "RollingUpgradePolicy": { - "type": "object", - "properties": { - "maxBatchInstancePercent": { - "oneOf": [ - { - "type": "integer", - "minimum": 5, - "maximum": 100 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer", - "minimum": 5, - "maximum": 100 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "maximum": 100 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "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)." - } - }, - "description": "The configuration parameters used while performing a rolling upgrade." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the number of virtual machines in the scale set." - } - }, - "description": "Describes a virtual machine scale set sku." - }, - "SourceVault": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" - }, - "SshConfiguration": { - "type": "object", - "properties": { - "publicKeys": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of SSH public keys used to authenticate with linux based VMs." - } - }, - "description": "SSH configuration for Linux based VMs running on Azure" - }, - "SshPublicKey": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "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" - }, - "keyData": { - "type": "string", - "description": "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)." - } - }, - "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." - }, - "StorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/OSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the storage settings for the virtual machine disks." - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - } - }, - "UpgradePolicy": { - "type": "object", - "properties": { - "mode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Automatic", - "Manual", - "Rolling" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/RollingUpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The configuration parameters used while performing a rolling upgrade." - }, - "automaticOSUpgrade": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." - } - }, - "description": "Describes an upgrade policy - automatic, manual, or rolling." - }, - "VaultCertificate": { - "type": "object", - "properties": { - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - }, - "certificateStore": { - "type": "string", - "description": "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." - } - }, - "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." - }, - "VaultSecretGroup": { - "type": "object", - "properties": { - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." - }, - "vaultCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of key vault references in SourceVault which contain certificates." - } - }, - "description": "Describes a set of certificates which are all in the same Key Vault." - }, - "VirtualHardDisk": { - "type": "object", - "properties": { - "uri": { - "type": "string", - "description": "Specifies the virtual hard disk's uri." - } - }, - "description": "Describes the uri of a disk." - }, - "VirtualMachineExtensionInstanceView": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The virtual machine extension name." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - }, - "statuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "instanceView": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionInstanceView" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine extension instance view." - } - }, - "description": "Describes the properties of a Virtual Machine Extension." - }, - "VirtualMachineIdentity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." - } - }, - "description": "Identity for the virtual machine." - }, - "VirtualMachineProperties": { - "type": "object", - "properties": { - "hardwareProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HardwareProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/StorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/OSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machine." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the network interfaces of the virtual machine." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "availabilitySet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "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" - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "VirtualMachineScaleSetDataDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The create option." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a virtual machine scale set data disk." - }, - "VirtualMachineScaleSetExtension": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the extension." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetExtensionProfile": { - "type": "object", - "properties": { - "extensions": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set child extension resources." - } - }, - "description": "Describes a virtual machine scale set extension profile." - }, - "VirtualMachineScaleSetExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "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." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetIdentity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." - } - }, - "description": "Identity for the virtual machine scale set." - }, - "VirtualMachineScaleSetIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The IP configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetIPConfigurationProperties": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/ApiEntityReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the identifier of the subnet." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - }, - "publicIPAddressConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The publicIPAddressConfiguration." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - } - }, - "description": "Describes a virtual machine scale set network profile's IP configuration properties." - }, - "VirtualMachineScaleSetManagedDiskParameters": { - "type": "object", - "properties": { - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "description": "Describes the parameters of a ScaleSet managed disk." - }, - "VirtualMachineScaleSetNetworkConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The network configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's network configurations." - }, - "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of DNS servers IP addresses" - } - }, - "description": "Describes a virtual machines scale sets network configuration's DNS settings." - }, - "VirtualMachineScaleSetNetworkConfigurationProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - }, - "enableAcceleratedNetworking": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether the network interface is accelerated networking-enabled." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network security group." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dns settings to be applied on the network interfaces." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the IP configurations of the network interface." - } - }, - "required": [ - "ipConfigurations" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetNetworkProfile": { - "type": "object", - "properties": { - "healthProbe": { - "oneOf": [ - { - "$ref": "#/definitions/ApiEntityReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." - }, - "networkInterfaceConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of network configurations." - } - }, - "description": "Describes a virtual machine scale set network profile." - }, - "VirtualMachineScaleSetOSDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." - }, - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the unmanaged user image to base the scale set on." - }, - "vhdContainers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the container urls that are used to store operating system disks for the scale set." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "createOption" - ], - "description": "Describes a virtual machine scale set operating system disk." - }, - "VirtualMachineScaleSetOSProfile": { - "type": "object", - "properties": { - "computerNamePrefix": { - "type": "string", - "description": "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." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "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)" - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." - } - }, - "description": "Describes a virtual machine scale set OS profile." - }, - "VirtualMachineScaleSetProperties": { - "type": "object", - "properties": { - "upgradePolicy": { - "oneOf": [ - { - "$ref": "#/definitions/UpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The upgrade policy." - }, - "virtualMachineProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine profile." - }, - "overprovision": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." - }, - "singlePlacementGroup": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set." - }, - "VirtualMachineScaleSetPublicIPAddressConfiguration": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The publicIP address configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" - }, - "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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" - } - }, - "required": [ - "domainNameLabel" - ], - "description": "Describes a virtual machines scale sets network configuration's DNS settings." - }, - "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { - "type": "object", - "properties": { - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The idle timeout of the public IP address." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dns settings to be applied on the publicIP addresses ." - } - }, - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" - }, - "VirtualMachineScaleSetStorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "virtualMachineScaleSets_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" - }, - "VirtualMachineScaleSetVMProfile": { - "type": "object", - "properties": { - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machines in the scale set." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "extensionProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." - }, - "licenseType": { - "type": "string", - "description": "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" - } - }, - "description": "Describes a virtual machine scale set virtual machine profile." - }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "WindowsConfiguration": { - "type": "object", - "properties": { - "provisionVMAgent": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "enableAutomaticUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether virtual machine is enabled for automatic updates." - }, - "timeZone": { - "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, - "additionalUnattendContent": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalUnattendContent" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." - }, - "winRM": { - "oneOf": [ - { - "$ref": "#/definitions/WinRMConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." - } - }, - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "WinRMConfiguration": { - "type": "object", - "properties": { - "listeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/WinRMListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of Windows Remote Management listeners" - } - }, - "description": "Describes Windows Remote Management configuration of the VM" - }, - "WinRMListener": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - } - }, - "description": "Describes Protocol and thumbprint of Windows Remote Management listener" - } - } -} diff --git a/test/Resource/Expected/Compute/2017-03-30/availabilitySets.md b/test/Resource/Expected/Compute/2017-03-30/availabilitySets.md deleted file mode 100644 index 16ad673..0000000 --- a/test/Resource/Expected/Compute/2017-03-30/availabilitySets.md +++ /dev/null @@ -1,70 +0,0 @@ -# Microsoft.Compute/availabilitySets template reference -API Version: 2017-03-30 -## Template format - -To create a Microsoft.Compute/availabilitySets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/availabilitySets", - "apiVersion": "2017-03-30", - "location": "string", - "tags": {}, - "properties": { - "platformUpdateDomainCount": "integer", - "platformFaultDomainCount": "integer", - "virtualMachines": [ - { - "id": "string" - } - ] - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/availabilitySets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/availabilitySets | -| apiVersion | enum | Yes | 2017-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [AvailabilitySetProperties object](#AvailabilitySetProperties) | -| sku | object | No | Sku of the availability set - [Sku object](#Sku) | - - - -### AvailabilitySetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| platformUpdateDomainCount | integer | No | Update Domain count. | -| platformFaultDomainCount | integer | No | Fault Domain count. | -| virtualMachines | array | No | A list of references to all virtual machines in the availability set. - [SubResource object](#SubResource) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The sku name. | -| tier | string | No | Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** | -| capacity | integer | No | Specifies the number of virtual machines in the scale set. | - - -     -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Compute/2017-03-30/disks.md b/test/Resource/Expected/Compute/2017-03-30/disks.md deleted file mode 100644 index 0b33973..0000000 --- a/test/Resource/Expected/Compute/2017-03-30/disks.md +++ /dev/null @@ -1,135 +0,0 @@ -# Microsoft.Compute/disks template reference -API Version: 2017-03-30 -## Template format - -To create a Microsoft.Compute/disks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/disks", - "apiVersion": "2017-03-30", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "zones": [ - "string" - ], - "properties": { - "osType": "string", - "creationData": { - "createOption": "string", - "storageAccountId": "string", - "imageReference": { - "id": "string", - "lun": "integer" - }, - "sourceUri": "string", - "sourceResourceId": "string" - }, - "diskSizeGB": "integer", - "encryptionSettings": { - "enabled": "boolean", - "diskEncryptionKey": { - "sourceVault": { - "id": "string" - }, - "secretUrl": "string" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "string" - }, - "keyUrl": "string" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/disks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the disk within the given subscription and resource group. | -| type | enum | Yes | Microsoft.Compute/disks | -| apiVersion | enum | Yes | 2017-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | [DiskSku object](#DiskSku) | -| zones | array | No | The Logical zone list for Disk. - string | -| properties | object | Yes | [DiskProperties object](#DiskProperties) | - - - -### DiskSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | The sku name. - Standard_LRS or Premium_LRS | - - - -### DiskProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | No | The Operating System type. - Windows or Linux | -| creationData | object | Yes | Disk source information. CreationData information cannot be changed after the disk has been created. - [CreationData object](#CreationData) | -| diskSizeGB | integer | No | 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 | object | No | Encryption settings for disk or snapshot - [EncryptionSettings object](#EncryptionSettings) | - - - -### CreationData object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| createOption | enum | Yes | This enumerates the possible sources of a disk's creation. - Empty, Attach, FromImage, Import, Copy | -| storageAccountId | string | No | 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 | -| imageReference | object | No | Disk source information. - [ImageDiskReference object](#ImageDiskReference) | -| sourceUri | string | No | If createOption is Import, this is the URI of a blob to be imported into a managed disk. | -| sourceResourceId | string | No | If createOption is Copy, this is the ARM id of the source snapshot or disk. | - - - -### EncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | 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. | -| diskEncryptionKey | object | No | Key Vault Secret Url and vault id of the disk encryption key - [KeyVaultAndSecretReference object](#KeyVaultAndSecretReference) | -| keyEncryptionKey | object | No | Key Vault Key Url and vault id of the key encryption key - [KeyVaultAndKeyReference object](#KeyVaultAndKeyReference) | - - - -### ImageDiskReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | A relative uri containing either a Platform Imgage Repository or user image reference. | -| lun | integer | No | 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. | - - - -### KeyVaultAndSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | Yes | Resource id of the KeyVault containing the key or secret - [SourceVault object](#SourceVault) | -| secretUrl | string | Yes | Url pointing to a key or secret in KeyVault | - - - -### KeyVaultAndKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | Yes | Resource id of the KeyVault containing the key or secret - [SourceVault object](#SourceVault) | -| keyUrl | string | Yes | Url pointing to a key or secret in KeyVault | - - - -### SourceVault object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Compute/2017-03-30/images.md b/test/Resource/Expected/Compute/2017-03-30/images.md deleted file mode 100644 index 0b42062..0000000 --- a/test/Resource/Expected/Compute/2017-03-30/images.md +++ /dev/null @@ -1,116 +0,0 @@ -# Microsoft.Compute/images template reference -API Version: 2017-03-30 -## Template format - -To create a Microsoft.Compute/images resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/images", - "apiVersion": "2017-03-30", - "location": "string", - "tags": {}, - "properties": { - "sourceVirtualMachine": { - "id": "string" - }, - "storageProfile": { - "osDisk": { - "osType": "string", - "osState": "string", - "snapshot": { - "id": "string" - }, - "managedDisk": { - "id": "string" - }, - "blobUri": "string", - "caching": "string", - "diskSizeGB": "integer", - "storageAccountType": "string" - }, - "dataDisks": [ - { - "lun": "integer", - "snapshot": { - "id": "string" - }, - "managedDisk": { - "id": "string" - }, - "blobUri": "string", - "caching": "string", - "diskSizeGB": "integer", - "storageAccountType": "string" - } - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/images object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/images | -| apiVersion | enum | Yes | 2017-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [ImageProperties object](#ImageProperties) | - - - -### ImageProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVirtualMachine | object | No | The source virtual machine from which Image is created. - [SubResource object](#SubResource) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [ImageStorageProfile object](#ImageStorageProfile) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### ImageStorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osDisk | object | Yes | 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). - [ImageOSDisk object](#ImageOSDisk) | -| dataDisks | array | No | 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). - [ImageDataDisk object](#ImageDataDisk) | - - -     -### ImageOSDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | Yes | This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| osState | enum | Yes | The OS State. - Generalized or Specialized | -| snapshot | object | No | The snapshot. - [SubResource object](#SubResource) | -| managedDisk | object | No | The managedDisk. - [SubResource object](#SubResource) | -| blobUri | string | No | The Virtual Hard Disk. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| diskSizeGB | integer | No | 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 | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - - -     -### ImageDataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | 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. | -| snapshot | object | No | The snapshot. - [SubResource object](#SubResource) | -| managedDisk | object | No | The managedDisk. - [SubResource object](#SubResource) | -| blobUri | string | No | The Virtual Hard Disk. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| diskSizeGB | integer | No | 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 | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - diff --git a/test/Resource/Expected/Compute/2017-03-30/snapshots.md b/test/Resource/Expected/Compute/2017-03-30/snapshots.md deleted file mode 100644 index c6f166c..0000000 --- a/test/Resource/Expected/Compute/2017-03-30/snapshots.md +++ /dev/null @@ -1,131 +0,0 @@ -# Microsoft.Compute/snapshots template reference -API Version: 2017-03-30 -## Template format - -To create a Microsoft.Compute/snapshots resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/snapshots", - "apiVersion": "2017-03-30", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "osType": "string", - "creationData": { - "createOption": "string", - "storageAccountId": "string", - "imageReference": { - "id": "string", - "lun": "integer" - }, - "sourceUri": "string", - "sourceResourceId": "string" - }, - "diskSizeGB": "integer", - "encryptionSettings": { - "enabled": "boolean", - "diskEncryptionKey": { - "sourceVault": { - "id": "string" - }, - "secretUrl": "string" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "string" - }, - "keyUrl": "string" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/snapshots object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the snapshot within the given subscription and resource group. | -| type | enum | Yes | Microsoft.Compute/snapshots | -| apiVersion | enum | Yes | 2017-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | [DiskSku object](#DiskSku) | -| properties | object | Yes | [DiskProperties object](#DiskProperties) | - - - -### DiskSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | The sku name. - Standard_LRS or Premium_LRS | - - - -### DiskProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | No | The Operating System type. - Windows or Linux | -| creationData | object | Yes | Disk source information. CreationData information cannot be changed after the disk has been created. - [CreationData object](#CreationData) | -| diskSizeGB | integer | No | 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 | object | No | Encryption settings for disk or snapshot - [EncryptionSettings object](#EncryptionSettings) | - - - -### CreationData object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| createOption | enum | Yes | This enumerates the possible sources of a disk's creation. - Empty, Attach, FromImage, Import, Copy | -| storageAccountId | string | No | 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 | -| imageReference | object | No | Disk source information. - [ImageDiskReference object](#ImageDiskReference) | -| sourceUri | string | No | If createOption is Import, this is the URI of a blob to be imported into a managed disk. | -| sourceResourceId | string | No | If createOption is Copy, this is the ARM id of the source snapshot or disk. | - - - -### EncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | 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. | -| diskEncryptionKey | object | No | Key Vault Secret Url and vault id of the disk encryption key - [KeyVaultAndSecretReference object](#KeyVaultAndSecretReference) | -| keyEncryptionKey | object | No | Key Vault Key Url and vault id of the key encryption key - [KeyVaultAndKeyReference object](#KeyVaultAndKeyReference) | - - - -### ImageDiskReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | A relative uri containing either a Platform Imgage Repository or user image reference. | -| lun | integer | No | 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. | - - - -### KeyVaultAndSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | Yes | Resource id of the KeyVault containing the key or secret - [SourceVault object](#SourceVault) | -| secretUrl | string | Yes | Url pointing to a key or secret in KeyVault | - - - -### KeyVaultAndKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | Yes | Resource id of the KeyVault containing the key or secret - [SourceVault object](#SourceVault) | -| keyUrl | string | Yes | Url pointing to a key or secret in KeyVault | - - - -### SourceVault object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Compute/2017-03-30/virtualMachineScaleSets.md b/test/Resource/Expected/Compute/2017-03-30/virtualMachineScaleSets.md deleted file mode 100644 index 4de7c99..0000000 --- a/test/Resource/Expected/Compute/2017-03-30/virtualMachineScaleSets.md +++ /dev/null @@ -1,590 +0,0 @@ -# Microsoft.Compute/virtualMachineScaleSets template reference -API Version: 2017-03-30 -## Template format - -To create a Microsoft.Compute/virtualMachineScaleSets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "apiVersion": "2017-03-30", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "plan": { - "name": "string", - "publisher": "string", - "product": "string", - "promotionCode": "string" - }, - "properties": { - "upgradePolicy": { - "mode": "string", - "rollingUpgradePolicy": { - "maxBatchInstancePercent": "integer", - "maxUnhealthyInstancePercent": "integer", - "maxUnhealthyUpgradedInstancePercent": "integer", - "pauseTimeBetweenBatches": "string" - }, - "automaticOSUpgrade": "boolean" - }, - "virtualMachineProfile": { - "osProfile": { - "computerNamePrefix": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "storageProfile": { - "imageReference": { - "id": "string", - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "name": "string", - "caching": "string", - "createOption": "string", - "osType": "string", - "image": { - "uri": "string" - }, - "vhdContainers": [ - "string" - ], - "managedDisk": { - "storageAccountType": "string" - } - }, - "dataDisks": [ - { - "name": "string", - "lun": "integer", - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "storageAccountType": "string" - } - } - ] - }, - "networkProfile": { - "healthProbe": { - "id": "string" - }, - "networkInterfaceConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "primary": "boolean", - "enableAcceleratedNetworking": "boolean", - "networkSecurityGroup": { - "id": "string" - }, - "dnsSettings": { - "dnsServers": [ - "string" - ] - }, - "ipConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "subnet": { - "id": "string" - }, - "primary": "boolean", - "publicIPAddressConfiguration": { - "name": "string", - "properties": { - "idleTimeoutInMinutes": "integer", - "dnsSettings": { - "domainNameLabel": "string" - } - } - }, - "privateIPAddressVersion": "string", - "applicationGatewayBackendAddressPools": [ - { - "id": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string" - } - ], - "loadBalancerInboundNatPools": [ - { - "id": "string" - } - ] - } - } - ] - } - } - ] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": "boolean", - "storageUri": "string" - } - }, - "extensionProfile": { - "extensions": [ - { - "name": "string", - "properties": { - "forceUpdateTag": "string", - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {} - } - } - ] - }, - "licenseType": "string" - }, - "overprovision": "boolean", - "singlePlacementGroup": "boolean" - }, - "identity": { - "type": "SystemAssigned" - }, - "zones": [ - "string" - ], - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachineScaleSets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachineScaleSets | -| apiVersion | enum | Yes | 2017-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | The virtual machine scale set sku. - [Sku object](#Sku) | -| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) | -| properties | object | Yes | [VirtualMachineScaleSetProperties object](#VirtualMachineScaleSetProperties) | -| identity | object | No | The identity of the virtual machine scale set, if configured. - [VirtualMachineScaleSetIdentity object](#VirtualMachineScaleSetIdentity) | -| zones | array | No | The virtual machine scale set zones. - string | -| resources | array | No | [extensions](./virtualMachineScaleSets/extensions.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The sku name. | -| tier | string | No | Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** | -| capacity | integer | No | Specifies the number of virtual machines in the scale set. | - - -     -### Plan object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The plan ID. | -| publisher | string | No | The publisher ID. | -| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | -| promotionCode | string | No | The promotion code. | - - - -### VirtualMachineScaleSetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| upgradePolicy | object | No | The upgrade policy. - [UpgradePolicy object](#UpgradePolicy) | -| virtualMachineProfile | object | No | The virtual machine profile. - [VirtualMachineScaleSetVMProfile object](#VirtualMachineScaleSetVMProfile) | -| overprovision | boolean | No | Specifies whether the Virtual Machine Scale Set should be overprovisioned. | -| singlePlacementGroup | boolean | No | When true this limits the scale set to a single placement group, of max size 100 virtual machines. | - - - -### VirtualMachineScaleSetIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | No | The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. - SystemAssigned | - - - -### UpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| mode | enum | No | 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. - Automatic, Manual, Rolling | -| rollingUpgradePolicy | object | No | The configuration parameters used while performing a rolling upgrade. - [RollingUpgradePolicy object](#RollingUpgradePolicy) | -| automaticOSUpgrade | boolean | No | Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. | - - -     -### VirtualMachineScaleSetVMProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osProfile | object | No | Specifies the operating system settings for the virtual machines in the scale set. - [VirtualMachineScaleSetOSProfile object](#VirtualMachineScaleSetOSProfile) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [VirtualMachineScaleSetStorageProfile object](#VirtualMachineScaleSetStorageProfile) | -| networkProfile | object | No | Specifies properties of the network interfaces of the virtual machines in the scale set. - [VirtualMachineScaleSetNetworkProfile object](#VirtualMachineScaleSetNetworkProfile) | -| diagnosticsProfile | object | No | Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - [DiagnosticsProfile object](#DiagnosticsProfile) | -| extensionProfile | object | No | Specifies a collection of settings for extensions installed on virtual machines in the scale set. - [VirtualMachineScaleSetExtensionProfile object](#VirtualMachineScaleSetExtensionProfile) | -| licenseType | string | No | 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 | - - -     -### RollingUpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maxBatchInstancePercent | integer | No | 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 | integer | No | 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 | integer | No | 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 | No | 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). | - - - -### VirtualMachineScaleSetOSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerNamePrefix | string | No | 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. | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | 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) | -| windowsConfiguration | object | No | Specifies Windows operating system settings on the virtual machine. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | Specifies the Linux operating system settings on the virtual machine.

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

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | Specifies set of certificates that should be installed onto the virtual machines in the scale set. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### VirtualMachineScaleSetStorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. - [ImageReference object](#ImageReference) | -| osDisk | object | No | Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [VirtualMachineScaleSetOSDisk object](#VirtualMachineScaleSetOSDisk) | -| dataDisks | array | No | 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). - [VirtualMachineScaleSetDataDisk object](#VirtualMachineScaleSetDataDisk) | - - -     -### VirtualMachineScaleSetNetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| healthProbe | object | No | A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - [ApiEntityReference object](#ApiEntityReference) | -| networkInterfaceConfigurations | array | No | The list of network configurations. - [VirtualMachineScaleSetNetworkConfiguration object](#VirtualMachineScaleSetNetworkConfiguration) | - - - -### DiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bootDiagnostics | object | No | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor. - [BootDiagnostics object](#BootDiagnostics) | - - -     -### VirtualMachineScaleSetExtensionProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| extensions | array | No | The virtual machine scale set child extension resources. - [VirtualMachineScaleSetExtension object](#VirtualMachineScaleSetExtension) | - - - -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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. | - - - -### VirtualMachineScaleSetOSDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The disk name. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. - FromImage, Empty, Attach | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| image | object | No | Specifies information about the unmanaged user image to base the scale set on. - [VirtualHardDisk object](#VirtualHardDisk) | -| vhdContainers | array | No | Specifies the container urls that are used to store operating system disks for the scale set. - string | -| managedDisk | object | No | The managed disk parameters. - [VirtualMachineScaleSetManagedDiskParameters object](#VirtualMachineScaleSetManagedDiskParameters) | - - -     -### VirtualMachineScaleSetDataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The disk name. | -| lun | integer | Yes | 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. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | The create option. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [VirtualMachineScaleSetManagedDiskParameters object](#VirtualMachineScaleSetManagedDiskParameters) | - - -     -### ApiEntityReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... | - - - -### VirtualMachineScaleSetNetworkConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The network configuration name. | -| properties | object | No | [VirtualMachineScaleSetNetworkConfigurationProperties object](#VirtualMachineScaleSetNetworkConfigurationProperties) | - - - -### BootDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | Whether boot diagnostics should be enabled on the Virtual Machine. | -| storageUri | string | No | Uri of the storage account to use for placing the console output and screenshot. | - - - -### VirtualMachineScaleSetExtension object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the extension. | -| properties | object | No | [VirtualMachineScaleSetExtensionProperties object](#VirtualMachineScaleSetExtensionProperties) | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### VirtualMachineScaleSetManagedDiskParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - - - -### VirtualMachineScaleSetNetworkConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | -| enableAcceleratedNetworking | boolean | No | Specifies whether the network interface is accelerated networking-enabled. | -| networkSecurityGroup | object | No | The network security group. - [SubResource object](#SubResource) | -| dnsSettings | object | No | The dns settings to be applied on the network interfaces. - [VirtualMachineScaleSetNetworkConfigurationDnsSettings object](#VirtualMachineScaleSetNetworkConfigurationDnsSettings) | -| ipConfigurations | array | Yes | Specifies the IP configurations of the network interface. - [VirtualMachineScaleSetIPConfiguration object](#VirtualMachineScaleSetIPConfiguration) | - - - -### VirtualMachineScaleSetExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceUpdateTag | string | No | 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. | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - - -     -### VirtualMachineScaleSetNetworkConfigurationDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | List of DNS servers IP addresses - string | - - - -### VirtualMachineScaleSetIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The IP configuration name. | -| properties | object | No | [VirtualMachineScaleSetIPConfigurationProperties object](#VirtualMachineScaleSetIPConfigurationProperties) | - - - -### VirtualMachineScaleSetIPConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Specifies the identifier of the subnet. - [ApiEntityReference object](#ApiEntityReference) | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | -| publicIPAddressConfiguration | object | No | The publicIPAddressConfiguration. - [VirtualMachineScaleSetPublicIPAddressConfiguration object](#VirtualMachineScaleSetPublicIPAddressConfiguration) | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| applicationGatewayBackendAddressPools | array | No | 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. - [SubResource object](#SubResource) | -| loadBalancerBackendAddressPools | array | No | 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. - [SubResource object](#SubResource) | -| loadBalancerInboundNatPools | array | No | 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 - [SubResource object](#SubResource) | - - - -### VirtualMachineScaleSetPublicIPAddressConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The publicIP address configuration name. | -| properties | object | No | [VirtualMachineScaleSetPublicIPAddressConfigurationProperties object](#VirtualMachineScaleSetPublicIPAddressConfigurationProperties) | - - - -### VirtualMachineScaleSetPublicIPAddressConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| dnsSettings | object | No | The dns settings to be applied on the publicIP addresses . - [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings object](#VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) | - - - -### VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | Yes | 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 | - diff --git a/test/Resource/Expected/Compute/2017-03-30/virtualMachineScaleSets/extensions.md b/test/Resource/Expected/Compute/2017-03-30/virtualMachineScaleSets/extensions.md deleted file mode 100644 index 15271ce..0000000 --- a/test/Resource/Expected/Compute/2017-03-30/virtualMachineScaleSets/extensions.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.Compute/virtualMachineScaleSets/extensions template reference -API Version: 2017-03-30 -## Template format - -To create a Microsoft.Compute/virtualMachineScaleSets/extensions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachineScaleSets/extensions", - "apiVersion": "2017-03-30", - "properties": { - "forceUpdateTag": "string", - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachineScaleSets/extensions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachineScaleSets/extensions | -| apiVersion | enum | Yes | 2017-03-30 | -| properties | object | Yes | [VirtualMachineScaleSetExtensionProperties object](#VirtualMachineScaleSetExtensionProperties) | - - - -### VirtualMachineScaleSetExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceUpdateTag | string | No | 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. | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | - diff --git a/test/Resource/Expected/Compute/2017-03-30/virtualMachines.md b/test/Resource/Expected/Compute/2017-03-30/virtualMachines.md deleted file mode 100644 index 5196c97..0000000 --- a/test/Resource/Expected/Compute/2017-03-30/virtualMachines.md +++ /dev/null @@ -1,441 +0,0 @@ -# Microsoft.Compute/virtualMachines template reference -API Version: 2017-03-30 -## Template format - -To create a Microsoft.Compute/virtualMachines resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines", - "apiVersion": "2017-03-30", - "location": "string", - "tags": {}, - "plan": { - "name": "string", - "publisher": "string", - "product": "string", - "promotionCode": "string" - }, - "properties": { - "hardwareProfile": { - "vmSize": "string" - }, - "storageProfile": { - "imageReference": { - "id": "string", - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "osType": "string", - "encryptionSettings": { - "diskEncryptionKey": { - "secretUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "keyEncryptionKey": { - "keyUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "enabled": "boolean" - }, - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "id": "string", - "storageAccountType": "string" - } - }, - "dataDisks": [ - { - "lun": "integer", - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "id": "string", - "storageAccountType": "string" - } - } - ] - }, - "osProfile": { - "computerName": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "string", - "properties": { - "primary": "boolean" - } - } - ] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": "boolean", - "storageUri": "string" - } - }, - "availabilitySet": { - "id": "string" - }, - "licenseType": "string" - }, - "identity": { - "type": "SystemAssigned" - }, - "zones": [ - "string" - ], - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachines object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines | -| apiVersion | enum | Yes | 2017-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) | -| properties | object | Yes | [VirtualMachineProperties object](#VirtualMachineProperties) | -| identity | object | No | The identity of the virtual machine, if configured. - [VirtualMachineIdentity object](#VirtualMachineIdentity) | -| zones | array | No | The virtual machine zones. - string | -| resources | array | No | [extensions](./virtualMachines/extensions.md) | - - - -### Plan object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The plan ID. | -| publisher | string | No | The publisher ID. | -| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | -| promotionCode | string | No | The promotion code. | - - - -### VirtualMachineProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| hardwareProfile | object | No | Specifies the hardware settings for the virtual machine. - [HardwareProfile object](#HardwareProfile) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [StorageProfile object](#StorageProfile) | -| osProfile | object | No | Specifies the operating system settings for the virtual machine. - [OSProfile object](#OSProfile) | -| networkProfile | object | No | Specifies the network interfaces of the virtual machine. - [NetworkProfile object](#NetworkProfile) | -| diagnosticsProfile | object | No | Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - [DiagnosticsProfile object](#DiagnosticsProfile) | -| availabilitySet | object | No | Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. - [SubResource object](#SubResource) | -| licenseType | string | No | 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 | - - -     -### VirtualMachineIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | No | The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. - SystemAssigned | - - - -### HardwareProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vmSize | enum | No | 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). - Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_A1_v2, Standard_A2_v2, Standard_A4_v2, Standard_A8_v2, Standard_A2m_v2, Standard_A4m_v2, Standard_A8m_v2, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_D15_v2, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_DS1_v2, Standard_DS2_v2, Standard_DS3_v2, Standard_DS4_v2, Standard_DS5_v2, Standard_DS11_v2, Standard_DS12_v2, Standard_DS13_v2, Standard_DS14_v2, Standard_DS15_v2, Standard_F1, Standard_F2, Standard_F4, Standard_F8, Standard_F16, Standard_F1s, Standard_F2s, Standard_F4s, Standard_F8s, Standard_F16s, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5, Standard_H8, Standard_H16, Standard_H8m, Standard_H16m, Standard_H16r, Standard_H16mr, Standard_L4s, Standard_L8s, Standard_L16s, Standard_L32s, Standard_NC6, Standard_NC12, Standard_NC24, Standard_NC24r, Standard_NV6, Standard_NV12, Standard_NV24 | - - -     -### StorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. - [ImageReference object](#ImageReference) | -| osDisk | object | No | Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [OSDisk object](#OSDisk) | -| dataDisks | array | No | 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). - [DataDisk object](#DataDisk) | - - -     -### OSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerName | string | No | Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | 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) | -| windowsConfiguration | object | No | Specifies Windows operating system settings on the virtual machine. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | Specifies the Linux operating system settings on the virtual machine.

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

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | Specifies set of certificates that should be installed onto the virtual machine. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### NetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| networkInterfaces | array | No | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. - [NetworkInterfaceReference object](#NetworkInterfaceReference) | - - - -### DiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bootDiagnostics | object | No | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor. - [BootDiagnostics object](#BootDiagnostics) | - - -     -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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 object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| encryptionSettings | object | No | Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 - [DiskEncryptionSettings object](#DiskEncryptionSettings) | -| name | string | No | The disk name. | -| vhd | object | No | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [ManagedDiskParameters object](#ManagedDiskParameters) | - - -     -### DataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | 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 | No | The disk name. | -| vhd | object | No | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [ManagedDiskParameters object](#ManagedDiskParameters) | - - -     -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### NetworkInterfaceReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceReferenceProperties object](#NetworkInterfaceReferenceProperties) | - - - -### BootDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | Whether boot diagnostics should be enabled on the Virtual Machine. | -| storageUri | string | No | Uri of the storage account to use for placing the console output and screenshot. | - - - -### DiskEncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| diskEncryptionKey | object | No | Specifies the location of the disk encryption key, which is a Key Vault Secret. - [KeyVaultSecretReference object](#KeyVaultSecretReference) | -| keyEncryptionKey | object | No | Specifies the location of the key encryption key in Key Vault. - [KeyVaultKeyReference object](#KeyVaultKeyReference) | -| enabled | boolean | No | Specifies whether disk encryption should be enabled on the virtual machine. | - - - -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### ManagedDiskParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### NetworkInterfaceReferenceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | - - - -### KeyVaultSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| secretUrl | string | Yes | The URL referencing a secret in a Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the secret. - [SubResource object](#SubResource) | - - - -### KeyVaultKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyUrl | string | Yes | The URL referencing a key encryption key in Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the key. - [SubResource object](#SubResource) | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - diff --git a/test/Resource/Expected/Compute/2017-03-30/virtualMachines/extensions.md b/test/Resource/Expected/Compute/2017-03-30/virtualMachines/extensions.md deleted file mode 100644 index 3ed56a7..0000000 --- a/test/Resource/Expected/Compute/2017-03-30/virtualMachines/extensions.md +++ /dev/null @@ -1,98 +0,0 @@ -# Microsoft.Compute/virtualMachines/extensions template reference -API Version: 2017-03-30 -## Template format - -To create a Microsoft.Compute/virtualMachines/extensions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines/extensions", - "apiVersion": "2017-03-30", - "location": "string", - "tags": {}, - "properties": { - "forceUpdateTag": "string", - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "string", - "type": "string", - "typeHandlerVersion": "string", - "substatuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ], - "statuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/virtualMachines/extensions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines/extensions | -| apiVersion | enum | Yes | 2017-03-30 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualMachineExtensionProperties object](#VirtualMachineExtensionProperties) | - - - -### VirtualMachineExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceUpdateTag | string | No | How the extension handler should be forced to update even if the extension configuration has not changed. | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | -| instanceView | object | No | The virtual machine extension instance view. - [VirtualMachineExtensionInstanceView object](#VirtualMachineExtensionInstanceView) | - - - -### VirtualMachineExtensionInstanceView object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The virtual machine extension name. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| substatuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | -| statuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | - - - -### InstanceViewStatus object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| code | string | No | The status code. | -| level | enum | No | The level code. - Info, Warning, Error | -| displayStatus | string | No | The short localizable label for the status. | -| message | string | No | The detailed status message, including for alerts and error messages. | -| time | string | No | The time of the status. | - diff --git a/test/Resource/Expected/Compute/2017-12-01/Microsoft.Compute.json b/test/Resource/Expected/Compute/2017-12-01/Microsoft.Compute.json deleted file mode 100644 index c489cb8..0000000 --- a/test/Resource/Expected/Compute/2017-12-01/Microsoft.Compute.json +++ /dev/null @@ -1,3294 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-12-01/Microsoft.Compute.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Compute", - "description": "Microsoft Compute Resource Types", - "resourceDefinitions": { - "availabilitySets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AvailabilitySetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sku of the availability set" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/availabilitySets" - }, - "images": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ImageProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/images" - }, - "virtualMachines": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the virtual machine, if configured." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachines_extensions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines" - }, - "virtualMachineScaleSets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set sku." - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the virtual machine scale set, if configured." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" - }, - { - "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets" - }, - "virtualMachineScaleSets_extensions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets/extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" - }, - "virtualMachineScaleSets_virtualmachines": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" - }, - "virtualMachines_extensions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines/extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - } - }, - "definitions": { - "AdditionalUnattendContent": { - "type": "object", - "properties": { - "passName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "OobeSystem" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." - }, - "componentName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft-Windows-Shell-Setup" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." - }, - "settingName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AutoLogon", - "FirstLogonCommands" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." - }, - "content": { - "type": "string", - "description": "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." - } - }, - "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." - }, - "ApiEntityReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." - } - }, - "description": "The API entity reference." - }, - "AvailabilitySetProperties": { - "type": "object", - "properties": { - "platformUpdateDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Update Domain count." - }, - "platformFaultDomainCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Fault Domain count." - }, - "virtualMachines": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references to all virtual machines in the availability set." - } - }, - "description": "The instance view of a resource." - }, - "BootDiagnostics": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether boot diagnostics should be enabled on the Virtual Machine." - }, - "storageUri": { - "type": "string", - "description": "Uri of the storage account to use for placing the console output and screenshot." - } - }, - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - }, - "DataDisk": { - "type": "object", - "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a data disk." - }, - "DiagnosticsProfile": { - "type": "object", - "properties": { - "bootDiagnostics": { - "oneOf": [ - { - "$ref": "#/definitions/BootDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." - } - }, - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "DiskEncryptionSettings": { - "type": "object", - "properties": { - "diskEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultSecretReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." - }, - "keyEncryptionKey": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultKeyReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the location of the key encryption key in Key Vault." - }, - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." - } - }, - "description": "Describes a Encryption Settings for a Disk" - }, - "HardwareProfile": { - "type": "object", - "properties": { - "vmSize": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic_A0", - "Basic_A1", - "Basic_A2", - "Basic_A3", - "Basic_A4", - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_A1_v2", - "Standard_A2_v2", - "Standard_A4_v2", - "Standard_A8_v2", - "Standard_A2m_v2", - "Standard_A4m_v2", - "Standard_A8m_v2", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_D15_v2", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_DS1_v2", - "Standard_DS2_v2", - "Standard_DS3_v2", - "Standard_DS4_v2", - "Standard_DS5_v2", - "Standard_DS11_v2", - "Standard_DS12_v2", - "Standard_DS13_v2", - "Standard_DS14_v2", - "Standard_DS15_v2", - "Standard_F1", - "Standard_F2", - "Standard_F4", - "Standard_F8", - "Standard_F16", - "Standard_F1s", - "Standard_F2s", - "Standard_F4s", - "Standard_F8s", - "Standard_F16s", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5", - "Standard_H8", - "Standard_H16", - "Standard_H8m", - "Standard_H16m", - "Standard_H16r", - "Standard_H16mr", - "Standard_L4s", - "Standard_L8s", - "Standard_L16s", - "Standard_L32s", - "Standard_NC6", - "Standard_NC12", - "Standard_NC24", - "Standard_NC24r", - "Standard_NV6", - "Standard_NV12", - "Standard_NV24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the hardware settings for the virtual machine." - }, - "ImageDataDisk": { - "type": "object", - "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "snapshot": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The snapshot." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "required": [ - "lun" - ], - "description": "Describes a data disk." - }, - "ImageOSDisk": { - "type": "object", - "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." - }, - "osState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Generalized", - "Specialized" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The OS State." - }, - "snapshot": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The snapshot." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "required": [ - "osType", - "osState" - ], - "description": "Describes an Operating System disk." - }, - "ImageProperties": { - "type": "object", - "properties": { - "sourceVirtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source virtual machine from which Image is created." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/ImageStorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - } - }, - "description": "Describes the properties of an Image." - }, - "ImageReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "publisher": { - "type": "string", - "description": "The image publisher." - }, - "offer": { - "type": "string", - "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." - }, - "sku": { - "type": "string", - "description": "The image SKU." - }, - "version": { - "type": "string", - "description": "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." - } - }, - "description": "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." - }, - "ImageStorageProfile": { - "type": "object", - "properties": { - "osDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ImageOSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "required": [ - "osDisk" - ], - "description": "Describes a storage profile." - }, - "InstanceViewStatus": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The status code." - }, - "level": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Info", - "Warning", - "Error" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The level code." - }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, - "message": { - "type": "string", - "description": "The detailed status message, including for alerts and error messages." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "The time of the status." - } - }, - "description": "Instance view status." - }, - "KeyVaultKeyReference": { - "type": "object", - "properties": { - "keyUrl": { - "type": "string", - "description": "The URL referencing a key encryption key in Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the key." - } - }, - "required": [ - "keyUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Key" - }, - "KeyVaultSecretReference": { - "type": "object", - "properties": { - "secretUrl": { - "type": "string", - "description": "The URL referencing a secret in a Key Vault." - }, - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing the secret." - } - }, - "required": [ - "secretUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Secret" - }, - "LinuxConfiguration": { - "type": "object", - "properties": { - "disablePasswordAuthentication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether password authentication should be disabled." - }, - "ssh": { - "oneOf": [ - { - "$ref": "#/definitions/SshConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the ssh key configuration for a Linux OS." - } - }, - "description": "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)." - }, - "ManagedDiskParameters": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "description": "The parameters of a managed disk." - }, - "NetworkInterfaceReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceReferenceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a network interface reference." - }, - "NetworkInterfaceReferenceProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - } - }, - "description": "Describes a network interface reference properties." - }, - "NetworkProfile": { - "type": "object", - "properties": { - "networkInterfaces": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." - } - }, - "description": "Specifies the network interfaces of the virtual machine." - }, - "OSDisk": { - "type": "object", - "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**." - }, - "encryptionSettings": { - "oneOf": [ - { - "$ref": "#/definitions/DiskEncryptionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "createOption" - ], - "description": "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)." - }, - "OSProfile": { - "type": "object", - "properties": { - "computerName": { - "type": "string", - "description": "Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "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)" - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies set of certificates that should be installed onto the virtual machine." - } - }, - "description": "Specifies the operating system settings for the virtual machine." - }, - "Plan": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The plan ID." - }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, - "product": { - "type": "string", - "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." - }, - "promotionCode": { - "type": "string", - "description": "The promotion code." - } - }, - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "RollingUpgradePolicy": { - "type": "object", - "properties": { - "maxBatchInstancePercent": { - "oneOf": [ - { - "type": "integer", - "minimum": 5, - "maximum": 100 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer", - "minimum": 5, - "maximum": 100 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "maximum": 100 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "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)." - } - }, - "description": "The configuration parameters used while performing a rolling upgrade." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the number of virtual machines in the scale set." - } - }, - "description": "Describes a virtual machine scale set sku." - }, - "SshConfiguration": { - "type": "object", - "properties": { - "publicKeys": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of SSH public keys used to authenticate with linux based VMs." - } - }, - "description": "SSH configuration for Linux based VMs running on Azure" - }, - "SshPublicKey": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "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" - }, - "keyData": { - "type": "string", - "description": "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)." - } - }, - "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." - }, - "StorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/OSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Specifies the storage settings for the virtual machine disks." - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - } - }, - "UpgradePolicy": { - "type": "object", - "properties": { - "mode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Automatic", - "Manual", - "Rolling" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/RollingUpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The configuration parameters used while performing a rolling upgrade." - }, - "automaticOSUpgrade": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." - } - }, - "description": "Describes an upgrade policy - automatic, manual, or rolling." - }, - "VaultCertificate": { - "type": "object", - "properties": { - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - }, - "certificateStore": { - "type": "string", - "description": "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." - } - }, - "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." - }, - "VaultSecretGroup": { - "type": "object", - "properties": { - "sourceVault": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." - }, - "vaultCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of key vault references in SourceVault which contain certificates." - } - }, - "description": "Describes a set of certificates which are all in the same Key Vault." - }, - "VirtualHardDisk": { - "type": "object", - "properties": { - "uri": { - "type": "string", - "description": "Specifies the virtual hard disk's uri." - } - }, - "description": "Describes the uri of a disk." - }, - "VirtualMachineExtensionInstanceView": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The virtual machine extension name." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - }, - "statuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "instanceView": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionInstanceView" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine extension instance view." - } - }, - "description": "Describes the properties of a Virtual Machine Extension." - }, - "VirtualMachineIdentity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "identityIds": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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}'." - } - }, - "description": "Identity for the virtual machine." - }, - "VirtualMachineProperties": { - "type": "object", - "properties": { - "hardwareProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HardwareProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/StorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/OSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machine." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the network interfaces of the virtual machine." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "availabilitySet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "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" - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "VirtualMachineScaleSetDataDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The create option." - }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a virtual machine scale set data disk." - }, - "VirtualMachineScaleSetExtension": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the extension." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetExtensionProfile": { - "type": "object", - "properties": { - "extensions": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set child extension resources." - } - }, - "description": "Describes a virtual machine scale set extension profile." - }, - "VirtualMachineScaleSetExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "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." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "settings": { - "type": "object", - "properties": {}, - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "properties": {}, - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetIdentity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set." - }, - "identityIds": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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}'." - } - }, - "description": "Identity for the virtual machine scale set." - }, - "VirtualMachineScaleSetIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The IP configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetIPConfigurationProperties": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/ApiEntityReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the identifier of the subnet." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - }, - "publicIPAddressConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The publicIPAddressConfiguration." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - } - }, - "description": "Describes a virtual machine scale set network profile's IP configuration properties." - }, - "VirtualMachineScaleSetManagedDiskParameters": { - "type": "object", - "properties": { - "storageAccountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." - } - }, - "description": "Describes the parameters of a ScaleSet managed disk." - }, - "VirtualMachineScaleSetNetworkConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "name": { - "type": "string", - "description": "The network configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's network configurations." - }, - "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of DNS servers IP addresses" - } - }, - "description": "Describes a virtual machines scale sets network configuration's DNS settings." - }, - "VirtualMachineScaleSetNetworkConfigurationProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - }, - "enableAcceleratedNetworking": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether the network interface is accelerated networking-enabled." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network security group." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dns settings to be applied on the network interfaces." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the IP configurations of the network interface." - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether IP forwarding enabled on this NIC." - } - }, - "required": [ - "ipConfigurations" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetNetworkProfile": { - "type": "object", - "properties": { - "healthProbe": { - "oneOf": [ - { - "$ref": "#/definitions/ApiEntityReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." - }, - "networkInterfaceConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of network configurations." - } - }, - "description": "Describes a virtual machine scale set network profile." - }, - "VirtualMachineScaleSetOSDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "createOption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." - }, - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the unmanaged user image to base the scale set on." - }, - "vhdContainers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the container urls that are used to store operating system disks for the scale set." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "createOption" - ], - "description": "Describes a virtual machine scale set operating system disk." - }, - "VirtualMachineScaleSetOSProfile": { - "type": "object", - "properties": { - "computerNamePrefix": { - "type": "string", - "description": "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." - }, - "adminUsername": { - "type": "string", - "description": "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)" - }, - "adminPassword": { - "type": "string", - "description": "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)" - }, - "customData": { - "type": "string", - "description": "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)" - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "linuxConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." - } - }, - "description": "Describes a virtual machine scale set OS profile." - }, - "VirtualMachineScaleSetProperties": { - "type": "object", - "properties": { - "upgradePolicy": { - "oneOf": [ - { - "$ref": "#/definitions/UpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The upgrade policy." - }, - "virtualMachineProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine profile." - }, - "overprovision": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." - }, - "singlePlacementGroup": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set." - }, - "VirtualMachineScaleSetPublicIPAddressConfiguration": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The publicIP address configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" - }, - "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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" - } - }, - "required": [ - "domainNameLabel" - ], - "description": "Describes a virtual machines scale sets network configuration's DNS settings." - }, - "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { - "type": "object", - "properties": { - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The idle timeout of the public IP address." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dns settings to be applied on the publicIP addresses ." - } - }, - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" - }, - "VirtualMachineScaleSetStorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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)." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "virtualMachineScaleSets_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" - }, - "virtualMachineScaleSets_virtualmachines_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualmachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" - }, - "VirtualMachineScaleSetVMProfile": { - "type": "object", - "properties": { - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machines in the scale set." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "extensionProfile": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." - }, - "licenseType": { - "type": "string", - "description": "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" - }, - "priority": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Regular", - "Low" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." - } - }, - "description": "Describes a virtual machine scale set virtual machine profile." - }, - "VirtualMachineScaleSetVMProperties": { - "type": "object", - "properties": { - "hardwareProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HardwareProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/StorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/OSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machine." - }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the network interfaces of the virtual machine." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "availabilitySet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "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" - } - }, - "description": "Describes the properties of a virtual machine scale set virtual machine." - }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "WindowsConfiguration": { - "type": "object", - "properties": { - "provisionVMAgent": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "enableAutomaticUpdates": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether virtual machine is enabled for automatic updates." - }, - "timeZone": { - "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, - "additionalUnattendContent": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalUnattendContent" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." - }, - "winRM": { - "oneOf": [ - { - "$ref": "#/definitions/WinRMConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." - } - }, - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "WinRMConfiguration": { - "type": "object", - "properties": { - "listeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/WinRMListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of Windows Remote Management listeners" - } - }, - "description": "Describes Windows Remote Management configuration of the VM" - }, - "WinRMListener": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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\":\"\"
    }" - } - }, - "description": "Describes Protocol and thumbprint of Windows Remote Management listener" - } - } -} diff --git a/test/Resource/Expected/Compute/2017-12-01/availabilitySets.md b/test/Resource/Expected/Compute/2017-12-01/availabilitySets.md deleted file mode 100644 index 2d79dac..0000000 --- a/test/Resource/Expected/Compute/2017-12-01/availabilitySets.md +++ /dev/null @@ -1,70 +0,0 @@ -# Microsoft.Compute/availabilitySets template reference -API Version: 2017-12-01 -## Template format - -To create a Microsoft.Compute/availabilitySets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/availabilitySets", - "apiVersion": "2017-12-01", - "location": "string", - "tags": {}, - "properties": { - "platformUpdateDomainCount": "integer", - "platformFaultDomainCount": "integer", - "virtualMachines": [ - { - "id": "string" - } - ] - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/availabilitySets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/availabilitySets | -| apiVersion | enum | Yes | 2017-12-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [AvailabilitySetProperties object](#AvailabilitySetProperties) | -| sku | object | No | Sku of the availability set - [Sku object](#Sku) | - - - -### AvailabilitySetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| platformUpdateDomainCount | integer | No | Update Domain count. | -| platformFaultDomainCount | integer | No | Fault Domain count. | -| virtualMachines | array | No | A list of references to all virtual machines in the availability set. - [SubResource object](#SubResource) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The sku name. | -| tier | string | No | Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** | -| capacity | integer | No | Specifies the number of virtual machines in the scale set. | - - -     -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Compute/2017-12-01/images.md b/test/Resource/Expected/Compute/2017-12-01/images.md deleted file mode 100644 index 2e416da..0000000 --- a/test/Resource/Expected/Compute/2017-12-01/images.md +++ /dev/null @@ -1,116 +0,0 @@ -# Microsoft.Compute/images template reference -API Version: 2017-12-01 -## Template format - -To create a Microsoft.Compute/images resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/images", - "apiVersion": "2017-12-01", - "location": "string", - "tags": {}, - "properties": { - "sourceVirtualMachine": { - "id": "string" - }, - "storageProfile": { - "osDisk": { - "osType": "string", - "osState": "string", - "snapshot": { - "id": "string" - }, - "managedDisk": { - "id": "string" - }, - "blobUri": "string", - "caching": "string", - "diskSizeGB": "integer", - "storageAccountType": "string" - }, - "dataDisks": [ - { - "lun": "integer", - "snapshot": { - "id": "string" - }, - "managedDisk": { - "id": "string" - }, - "blobUri": "string", - "caching": "string", - "diskSizeGB": "integer", - "storageAccountType": "string" - } - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/images object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/images | -| apiVersion | enum | Yes | 2017-12-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [ImageProperties object](#ImageProperties) | - - - -### ImageProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVirtualMachine | object | No | The source virtual machine from which Image is created. - [SubResource object](#SubResource) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [ImageStorageProfile object](#ImageStorageProfile) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### ImageStorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osDisk | object | Yes | 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). - [ImageOSDisk object](#ImageOSDisk) | -| dataDisks | array | No | 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). - [ImageDataDisk object](#ImageDataDisk) | - - -     -### ImageOSDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | Yes | This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| osState | enum | Yes | The OS State. - Generalized or Specialized | -| snapshot | object | No | The snapshot. - [SubResource object](#SubResource) | -| managedDisk | object | No | The managedDisk. - [SubResource object](#SubResource) | -| blobUri | string | No | The Virtual Hard Disk. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| diskSizeGB | integer | No | 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 | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - - -     -### ImageDataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | 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. | -| snapshot | object | No | The snapshot. - [SubResource object](#SubResource) | -| managedDisk | object | No | The managedDisk. - [SubResource object](#SubResource) | -| blobUri | string | No | The Virtual Hard Disk. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| diskSizeGB | integer | No | 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 | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - diff --git a/test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets.md b/test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets.md deleted file mode 100644 index d68cee7..0000000 --- a/test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets.md +++ /dev/null @@ -1,598 +0,0 @@ -# Microsoft.Compute/virtualMachineScaleSets template reference -API Version: 2017-12-01 -## Template format - -To create a Microsoft.Compute/virtualMachineScaleSets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "apiVersion": "2017-12-01", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "plan": { - "name": "string", - "publisher": "string", - "product": "string", - "promotionCode": "string" - }, - "properties": { - "upgradePolicy": { - "mode": "string", - "rollingUpgradePolicy": { - "maxBatchInstancePercent": "integer", - "maxUnhealthyInstancePercent": "integer", - "maxUnhealthyUpgradedInstancePercent": "integer", - "pauseTimeBetweenBatches": "string" - }, - "automaticOSUpgrade": "boolean" - }, - "virtualMachineProfile": { - "osProfile": { - "computerNamePrefix": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "storageProfile": { - "imageReference": { - "id": "string", - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "name": "string", - "caching": "string", - "createOption": "string", - "osType": "string", - "image": { - "uri": "string" - }, - "vhdContainers": [ - "string" - ], - "managedDisk": { - "storageAccountType": "string" - } - }, - "dataDisks": [ - { - "name": "string", - "lun": "integer", - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "storageAccountType": "string" - } - } - ] - }, - "networkProfile": { - "healthProbe": { - "id": "string" - }, - "networkInterfaceConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "primary": "boolean", - "enableAcceleratedNetworking": "boolean", - "networkSecurityGroup": { - "id": "string" - }, - "dnsSettings": { - "dnsServers": [ - "string" - ] - }, - "ipConfigurations": [ - { - "id": "string", - "name": "string", - "properties": { - "subnet": { - "id": "string" - }, - "primary": "boolean", - "publicIPAddressConfiguration": { - "name": "string", - "properties": { - "idleTimeoutInMinutes": "integer", - "dnsSettings": { - "domainNameLabel": "string" - } - } - }, - "privateIPAddressVersion": "string", - "applicationGatewayBackendAddressPools": [ - { - "id": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string" - } - ], - "loadBalancerInboundNatPools": [ - { - "id": "string" - } - ] - } - } - ], - "enableIPForwarding": "boolean" - } - } - ] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": "boolean", - "storageUri": "string" - } - }, - "extensionProfile": { - "extensions": [ - { - "name": "string", - "properties": { - "forceUpdateTag": "string", - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {} - } - } - ] - }, - "licenseType": "string", - "priority": "string" - }, - "overprovision": "boolean", - "singlePlacementGroup": "boolean" - }, - "identity": { - "type": "string", - "identityIds": [ - "string" - ] - }, - "zones": [ - "string" - ], - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/virtualMachineScaleSets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachineScaleSets | -| apiVersion | enum | Yes | 2017-12-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | The virtual machine scale set sku. - [Sku object](#Sku) | -| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) | -| properties | object | Yes | [VirtualMachineScaleSetProperties object](#VirtualMachineScaleSetProperties) | -| identity | object | No | The identity of the virtual machine scale set, if configured. - [VirtualMachineScaleSetIdentity object](#VirtualMachineScaleSetIdentity) | -| zones | array | No | The virtual machine scale set zones. - string | -| resources | array | No | [virtualmachines](./virtualMachineScaleSets/virtualmachines.md) [extensions](./virtualMachineScaleSets/extensions.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The sku name. | -| tier | string | No | Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** | -| capacity | integer | No | Specifies the number of virtual machines in the scale set. | - - -     -### Plan object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The plan ID. | -| publisher | string | No | The publisher ID. | -| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | -| promotionCode | string | No | The promotion code. | - - - -### VirtualMachineScaleSetProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| upgradePolicy | object | No | The upgrade policy. - [UpgradePolicy object](#UpgradePolicy) | -| virtualMachineProfile | object | No | The virtual machine profile. - [VirtualMachineScaleSetVMProfile object](#VirtualMachineScaleSetVMProfile) | -| overprovision | boolean | No | Specifies whether the Virtual Machine Scale Set should be overprovisioned. | -| singlePlacementGroup | boolean | No | When true this limits the scale set to a single placement group, of max size 100 virtual machines. | - - - -### VirtualMachineScaleSetIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | No | The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. - SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None | -| identityIds | array | No | 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}'. - string | - - - -### UpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| mode | enum | No | 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. - Automatic, Manual, Rolling | -| rollingUpgradePolicy | object | No | The configuration parameters used while performing a rolling upgrade. - [RollingUpgradePolicy object](#RollingUpgradePolicy) | -| automaticOSUpgrade | boolean | No | Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. | - - -     -### VirtualMachineScaleSetVMProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osProfile | object | No | Specifies the operating system settings for the virtual machines in the scale set. - [VirtualMachineScaleSetOSProfile object](#VirtualMachineScaleSetOSProfile) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [VirtualMachineScaleSetStorageProfile object](#VirtualMachineScaleSetStorageProfile) | -| networkProfile | object | No | Specifies properties of the network interfaces of the virtual machines in the scale set. - [VirtualMachineScaleSetNetworkProfile object](#VirtualMachineScaleSetNetworkProfile) | -| diagnosticsProfile | object | No | Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - [DiagnosticsProfile object](#DiagnosticsProfile) | -| extensionProfile | object | No | Specifies a collection of settings for extensions installed on virtual machines in the scale set. - [VirtualMachineScaleSetExtensionProfile object](#VirtualMachineScaleSetExtensionProfile) | -| licenseType | string | No | 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 | -| priority | enum | No | Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview. - Regular or Low | - - -     -### RollingUpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maxBatchInstancePercent | integer | No | 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 | integer | No | 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 | integer | No | 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 | No | 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). | - - - -### VirtualMachineScaleSetOSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerNamePrefix | string | No | 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. | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | 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) | -| windowsConfiguration | object | No | Specifies Windows operating system settings on the virtual machine. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | Specifies the Linux operating system settings on the virtual machine.

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

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | Specifies set of certificates that should be installed onto the virtual machines in the scale set. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### VirtualMachineScaleSetStorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. - [ImageReference object](#ImageReference) | -| osDisk | object | No | Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [VirtualMachineScaleSetOSDisk object](#VirtualMachineScaleSetOSDisk) | -| dataDisks | array | No | 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). - [VirtualMachineScaleSetDataDisk object](#VirtualMachineScaleSetDataDisk) | - - -     -### VirtualMachineScaleSetNetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| healthProbe | object | No | A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. - [ApiEntityReference object](#ApiEntityReference) | -| networkInterfaceConfigurations | array | No | The list of network configurations. - [VirtualMachineScaleSetNetworkConfiguration object](#VirtualMachineScaleSetNetworkConfiguration) | - - - -### DiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bootDiagnostics | object | No | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor. - [BootDiagnostics object](#BootDiagnostics) | - - -     -### VirtualMachineScaleSetExtensionProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| extensions | array | No | The virtual machine scale set child extension resources. - [VirtualMachineScaleSetExtension object](#VirtualMachineScaleSetExtension) | - - - -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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. | - - - -### VirtualMachineScaleSetOSDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The disk name. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. - FromImage, Empty, Attach | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| image | object | No | Specifies information about the unmanaged user image to base the scale set on. - [VirtualHardDisk object](#VirtualHardDisk) | -| vhdContainers | array | No | Specifies the container urls that are used to store operating system disks for the scale set. - string | -| managedDisk | object | No | The managed disk parameters. - [VirtualMachineScaleSetManagedDiskParameters object](#VirtualMachineScaleSetManagedDiskParameters) | - - -     -### VirtualMachineScaleSetDataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The disk name. | -| lun | integer | Yes | 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. | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | The create option. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [VirtualMachineScaleSetManagedDiskParameters object](#VirtualMachineScaleSetManagedDiskParameters) | - - -     -### ApiEntityReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/... | - - - -### VirtualMachineScaleSetNetworkConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The network configuration name. | -| properties | object | No | [VirtualMachineScaleSetNetworkConfigurationProperties object](#VirtualMachineScaleSetNetworkConfigurationProperties) | - - - -### BootDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | Whether boot diagnostics should be enabled on the Virtual Machine. | -| storageUri | string | No | Uri of the storage account to use for placing the console output and screenshot. | - - - -### VirtualMachineScaleSetExtension object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the extension. | -| properties | object | No | [VirtualMachineScaleSetExtensionProperties object](#VirtualMachineScaleSetExtensionProperties) | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### VirtualMachineScaleSetManagedDiskParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - - - -### VirtualMachineScaleSetNetworkConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | -| enableAcceleratedNetworking | boolean | No | Specifies whether the network interface is accelerated networking-enabled. | -| networkSecurityGroup | object | No | The network security group. - [SubResource object](#SubResource) | -| dnsSettings | object | No | The dns settings to be applied on the network interfaces. - [VirtualMachineScaleSetNetworkConfigurationDnsSettings object](#VirtualMachineScaleSetNetworkConfigurationDnsSettings) | -| ipConfigurations | array | Yes | Specifies the IP configurations of the network interface. - [VirtualMachineScaleSetIPConfiguration object](#VirtualMachineScaleSetIPConfiguration) | -| enableIPForwarding | boolean | No | Whether IP forwarding enabled on this NIC. | - - - -### VirtualMachineScaleSetExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceUpdateTag | string | No | 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. | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - - -     -### VirtualMachineScaleSetNetworkConfigurationDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | List of DNS servers IP addresses - string | - - - -### VirtualMachineScaleSetIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| name | string | Yes | The IP configuration name. | -| properties | object | No | [VirtualMachineScaleSetIPConfigurationProperties object](#VirtualMachineScaleSetIPConfigurationProperties) | - - - -### VirtualMachineScaleSetIPConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Specifies the identifier of the subnet. - [ApiEntityReference object](#ApiEntityReference) | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | -| publicIPAddressConfiguration | object | No | The publicIPAddressConfiguration. - [VirtualMachineScaleSetPublicIPAddressConfiguration object](#VirtualMachineScaleSetPublicIPAddressConfiguration) | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| applicationGatewayBackendAddressPools | array | No | 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. - [SubResource object](#SubResource) | -| loadBalancerBackendAddressPools | array | No | 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. - [SubResource object](#SubResource) | -| loadBalancerInboundNatPools | array | No | 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 - [SubResource object](#SubResource) | - - - -### VirtualMachineScaleSetPublicIPAddressConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The publicIP address configuration name. | -| properties | object | No | [VirtualMachineScaleSetPublicIPAddressConfigurationProperties object](#VirtualMachineScaleSetPublicIPAddressConfigurationProperties) | - - - -### VirtualMachineScaleSetPublicIPAddressConfigurationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| dnsSettings | object | No | The dns settings to be applied on the publicIP addresses . - [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings object](#VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) | - - - -### VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | Yes | 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 | - diff --git a/test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets/extensions.md b/test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets/extensions.md deleted file mode 100644 index 16da565..0000000 --- a/test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets/extensions.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.Compute/virtualMachineScaleSets/extensions template reference -API Version: 2017-12-01 -## Template format - -To create a Microsoft.Compute/virtualMachineScaleSets/extensions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachineScaleSets/extensions", - "apiVersion": "2017-12-01", - "properties": { - "forceUpdateTag": "string", - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachineScaleSets/extensions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachineScaleSets/extensions | -| apiVersion | enum | Yes | 2017-12-01 | -| properties | object | Yes | [VirtualMachineScaleSetExtensionProperties object](#VirtualMachineScaleSetExtensionProperties) | - - - -### VirtualMachineScaleSetExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceUpdateTag | string | No | 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. | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | - diff --git a/test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets/virtualmachines.md b/test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets/virtualmachines.md deleted file mode 100644 index 9b727b2..0000000 --- a/test/Resource/Expected/Compute/2017-12-01/virtualMachineScaleSets/virtualmachines.md +++ /dev/null @@ -1,424 +0,0 @@ -# Microsoft.Compute/virtualMachineScaleSets/virtualmachines template reference -API Version: 2017-12-01 -## Template format - -To create a Microsoft.Compute/virtualMachineScaleSets/virtualmachines resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines", - "apiVersion": "2017-12-01", - "location": "string", - "tags": {}, - "properties": { - "hardwareProfile": { - "vmSize": "string" - }, - "storageProfile": { - "imageReference": { - "id": "string", - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "osType": "string", - "encryptionSettings": { - "diskEncryptionKey": { - "secretUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "keyEncryptionKey": { - "keyUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "enabled": "boolean" - }, - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "id": "string", - "storageAccountType": "string" - } - }, - "dataDisks": [ - { - "lun": "integer", - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "id": "string", - "storageAccountType": "string" - } - } - ] - }, - "osProfile": { - "computerName": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "string", - "properties": { - "primary": "boolean" - } - } - ] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": "boolean", - "storageUri": "string" - } - }, - "availabilitySet": { - "id": "string" - }, - "licenseType": "string" - }, - "plan": { - "name": "string", - "publisher": "string", - "product": "string", - "promotionCode": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Compute/virtualMachineScaleSets/virtualmachines object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachineScaleSets/virtualmachines | -| apiVersion | enum | Yes | 2017-12-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualMachineScaleSetVMProperties object](#VirtualMachineScaleSetVMProperties) | -| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) | - - - -### VirtualMachineScaleSetVMProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| hardwareProfile | object | No | Specifies the hardware settings for the virtual machine. - [HardwareProfile object](#HardwareProfile) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [StorageProfile object](#StorageProfile) | -| osProfile | object | No | Specifies the operating system settings for the virtual machine. - [OSProfile object](#OSProfile) | -| networkProfile | object | No | Specifies the network interfaces of the virtual machine. - [NetworkProfile object](#NetworkProfile) | -| diagnosticsProfile | object | No | Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - [DiagnosticsProfile object](#DiagnosticsProfile) | -| availabilitySet | object | No | Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. - [SubResource object](#SubResource) | -| licenseType | string | No | 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 | - - -     -### Plan object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The plan ID. | -| publisher | string | No | The publisher ID. | -| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | -| promotionCode | string | No | The promotion code. | - - - -### HardwareProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vmSize | enum | No | 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). - Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_A1_v2, Standard_A2_v2, Standard_A4_v2, Standard_A8_v2, Standard_A2m_v2, Standard_A4m_v2, Standard_A8m_v2, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_D15_v2, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_DS1_v2, Standard_DS2_v2, Standard_DS3_v2, Standard_DS4_v2, Standard_DS5_v2, Standard_DS11_v2, Standard_DS12_v2, Standard_DS13_v2, Standard_DS14_v2, Standard_DS15_v2, Standard_F1, Standard_F2, Standard_F4, Standard_F8, Standard_F16, Standard_F1s, Standard_F2s, Standard_F4s, Standard_F8s, Standard_F16s, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5, Standard_H8, Standard_H16, Standard_H8m, Standard_H16m, Standard_H16r, Standard_H16mr, Standard_L4s, Standard_L8s, Standard_L16s, Standard_L32s, Standard_NC6, Standard_NC12, Standard_NC24, Standard_NC24r, Standard_NV6, Standard_NV12, Standard_NV24 | - - -     -### StorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. - [ImageReference object](#ImageReference) | -| osDisk | object | No | Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [OSDisk object](#OSDisk) | -| dataDisks | array | No | 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). - [DataDisk object](#DataDisk) | - - -     -### OSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerName | string | No | Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | 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) | -| windowsConfiguration | object | No | Specifies Windows operating system settings on the virtual machine. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | Specifies the Linux operating system settings on the virtual machine.

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

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | Specifies set of certificates that should be installed onto the virtual machine. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### NetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| networkInterfaces | array | No | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. - [NetworkInterfaceReference object](#NetworkInterfaceReference) | - - - -### DiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bootDiagnostics | object | No | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor. - [BootDiagnostics object](#BootDiagnostics) | - - -     -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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 object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| encryptionSettings | object | No | Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 - [DiskEncryptionSettings object](#DiskEncryptionSettings) | -| name | string | No | The disk name. | -| vhd | object | No | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [ManagedDiskParameters object](#ManagedDiskParameters) | - - -     -### DataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | 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 | No | The disk name. | -| vhd | object | No | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [ManagedDiskParameters object](#ManagedDiskParameters) | - - -     -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### NetworkInterfaceReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceReferenceProperties object](#NetworkInterfaceReferenceProperties) | - - - -### BootDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | Whether boot diagnostics should be enabled on the Virtual Machine. | -| storageUri | string | No | Uri of the storage account to use for placing the console output and screenshot. | - - - -### DiskEncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| diskEncryptionKey | object | No | Specifies the location of the disk encryption key, which is a Key Vault Secret. - [KeyVaultSecretReference object](#KeyVaultSecretReference) | -| keyEncryptionKey | object | No | Specifies the location of the key encryption key in Key Vault. - [KeyVaultKeyReference object](#KeyVaultKeyReference) | -| enabled | boolean | No | Specifies whether disk encryption should be enabled on the virtual machine. | - - - -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### ManagedDiskParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### NetworkInterfaceReferenceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | - - - -### KeyVaultSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| secretUrl | string | Yes | The URL referencing a secret in a Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the secret. - [SubResource object](#SubResource) | - - - -### KeyVaultKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyUrl | string | Yes | The URL referencing a key encryption key in Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the key. - [SubResource object](#SubResource) | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - diff --git a/test/Resource/Expected/Compute/2017-12-01/virtualMachines.md b/test/Resource/Expected/Compute/2017-12-01/virtualMachines.md deleted file mode 100644 index bbed084..0000000 --- a/test/Resource/Expected/Compute/2017-12-01/virtualMachines.md +++ /dev/null @@ -1,445 +0,0 @@ -# Microsoft.Compute/virtualMachines template reference -API Version: 2017-12-01 -## Template format - -To create a Microsoft.Compute/virtualMachines resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines", - "apiVersion": "2017-12-01", - "location": "string", - "tags": {}, - "plan": { - "name": "string", - "publisher": "string", - "product": "string", - "promotionCode": "string" - }, - "properties": { - "hardwareProfile": { - "vmSize": "string" - }, - "storageProfile": { - "imageReference": { - "id": "string", - "publisher": "string", - "offer": "string", - "sku": "string", - "version": "string" - }, - "osDisk": { - "osType": "string", - "encryptionSettings": { - "diskEncryptionKey": { - "secretUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "keyEncryptionKey": { - "keyUrl": "string", - "sourceVault": { - "id": "string" - } - }, - "enabled": "boolean" - }, - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "id": "string", - "storageAccountType": "string" - } - }, - "dataDisks": [ - { - "lun": "integer", - "name": "string", - "vhd": { - "uri": "string" - }, - "image": { - "uri": "string" - }, - "caching": "string", - "createOption": "string", - "diskSizeGB": "integer", - "managedDisk": { - "id": "string", - "storageAccountType": "string" - } - } - ] - }, - "osProfile": { - "computerName": "string", - "adminUsername": "string", - "adminPassword": "string", - "customData": "string", - "windowsConfiguration": { - "provisionVMAgent": "boolean", - "enableAutomaticUpdates": "boolean", - "timeZone": "string", - "additionalUnattendContent": [ - { - "passName": "OobeSystem", - "componentName": "Microsoft-Windows-Shell-Setup", - "settingName": "string", - "content": "string" - } - ], - "winRM": { - "listeners": [ - { - "protocol": "string", - "certificateUrl": "string" - } - ] - } - }, - "linuxConfiguration": { - "disablePasswordAuthentication": "boolean", - "ssh": { - "publicKeys": [ - { - "path": "string", - "keyData": "string" - } - ] - } - }, - "secrets": [ - { - "sourceVault": { - "id": "string" - }, - "vaultCertificates": [ - { - "certificateUrl": "string", - "certificateStore": "string" - } - ] - } - ] - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "string", - "properties": { - "primary": "boolean" - } - } - ] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": "boolean", - "storageUri": "string" - } - }, - "availabilitySet": { - "id": "string" - }, - "licenseType": "string" - }, - "identity": { - "type": "string", - "identityIds": [ - "string" - ] - }, - "zones": [ - "string" - ], - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/virtualMachines object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines | -| apiVersion | enum | Yes | 2017-12-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| plan | object | No | Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. - [Plan object](#Plan) | -| properties | object | Yes | [VirtualMachineProperties object](#VirtualMachineProperties) | -| identity | object | No | The identity of the virtual machine, if configured. - [VirtualMachineIdentity object](#VirtualMachineIdentity) | -| zones | array | No | The virtual machine zones. - string | -| resources | array | No | [extensions](./virtualMachines/extensions.md) | - - - -### Plan object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The plan ID. | -| publisher | string | No | The publisher ID. | -| product | string | No | Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. | -| promotionCode | string | No | The promotion code. | - - - -### VirtualMachineProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| hardwareProfile | object | No | Specifies the hardware settings for the virtual machine. - [HardwareProfile object](#HardwareProfile) | -| storageProfile | object | No | Specifies the storage settings for the virtual machine disks. - [StorageProfile object](#StorageProfile) | -| osProfile | object | No | Specifies the operating system settings for the virtual machine. - [OSProfile object](#OSProfile) | -| networkProfile | object | No | Specifies the network interfaces of the virtual machine. - [NetworkProfile object](#NetworkProfile) | -| diagnosticsProfile | object | No | Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. - [DiagnosticsProfile object](#DiagnosticsProfile) | -| availabilitySet | object | No | Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

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

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. - [SubResource object](#SubResource) | -| licenseType | string | No | 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 | - - -     -### VirtualMachineIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | No | 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. - SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None | -| identityIds | array | No | 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}'. - string | - - - -### HardwareProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vmSize | enum | No | 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). - Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_A1_v2, Standard_A2_v2, Standard_A4_v2, Standard_A8_v2, Standard_A2m_v2, Standard_A4m_v2, Standard_A8m_v2, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_D15_v2, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_DS1_v2, Standard_DS2_v2, Standard_DS3_v2, Standard_DS4_v2, Standard_DS5_v2, Standard_DS11_v2, Standard_DS12_v2, Standard_DS13_v2, Standard_DS14_v2, Standard_DS15_v2, Standard_F1, Standard_F2, Standard_F4, Standard_F8, Standard_F16, Standard_F1s, Standard_F2s, Standard_F4s, Standard_F8s, Standard_F16s, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5, Standard_H8, Standard_H16, Standard_H8m, Standard_H16m, Standard_H16r, Standard_H16mr, Standard_L4s, Standard_L8s, Standard_L16s, Standard_L32s, Standard_NC6, Standard_NC12, Standard_NC24, Standard_NC24r, Standard_NV6, Standard_NV12, Standard_NV24 | - - -     -### StorageProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageReference | object | No | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. - [ImageReference object](#ImageReference) | -| osDisk | object | No | Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). - [OSDisk object](#OSDisk) | -| dataDisks | array | No | 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). - [DataDisk object](#DataDisk) | - - -     -### OSProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| computerName | string | No | Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions). | -| adminUsername | string | No | 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) | -| adminPassword | string | No | 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) | -| customData | string | No | 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) | -| windowsConfiguration | object | No | Specifies Windows operating system settings on the virtual machine. - [WindowsConfiguration object](#WindowsConfiguration) | -| linuxConfiguration | object | No | Specifies the Linux operating system settings on the virtual machine.

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

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). - [LinuxConfiguration object](#LinuxConfiguration) | -| secrets | array | No | Specifies set of certificates that should be installed onto the virtual machine. - [VaultSecretGroup object](#VaultSecretGroup) | - - -     -### NetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| networkInterfaces | array | No | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. - [NetworkInterfaceReference object](#NetworkInterfaceReference) | - - - -### DiagnosticsProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bootDiagnostics | object | No | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

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

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor. - [BootDiagnostics object](#BootDiagnostics) | - - -     -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### ImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| publisher | string | No | The image publisher. | -| offer | string | No | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | -| sku | string | No | The image SKU. | -| version | string | No | 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 object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| osType | enum | No | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**. - Windows or Linux | -| encryptionSettings | object | No | Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 - [DiskEncryptionSettings object](#DiskEncryptionSettings) | -| name | string | No | The disk name. | -| vhd | object | No | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [ManagedDiskParameters object](#ManagedDiskParameters) | - - -     -### DataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lun | integer | Yes | 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 | No | The disk name. | -| vhd | object | No | The virtual hard disk. - [VirtualHardDisk object](#VirtualHardDisk) | -| image | object | No | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - [VirtualHardDisk object](#VirtualHardDisk) | -| caching | enum | No | Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**. - None, ReadOnly, ReadWrite | -| createOption | enum | Yes | 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. - FromImage, Empty, Attach | -| diskSizeGB | integer | No | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB | -| managedDisk | object | No | The managed disk parameters. - [ManagedDiskParameters object](#ManagedDiskParameters) | - - -     -### WindowsConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisionVMAgent | boolean | No | 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. | -| enableAutomaticUpdates | boolean | No | Indicates whether virtual machine is enabled for automatic updates. | -| timeZone | string | No | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" | -| additionalUnattendContent | array | No | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - [AdditionalUnattendContent object](#AdditionalUnattendContent) | -| winRM | object | No | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - [WinRMConfiguration object](#WinRMConfiguration) | - - -     -### LinuxConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disablePasswordAuthentication | boolean | No | Specifies whether password authentication should be disabled. | -| ssh | object | No | Specifies the ssh key configuration for a Linux OS. - [SshConfiguration object](#SshConfiguration) | - - - -### VaultSecretGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVault | object | No | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - [SubResource object](#SubResource) | -| vaultCertificates | array | No | The list of key vault references in SourceVault which contain certificates. - [VaultCertificate object](#VaultCertificate) | - - - -### NetworkInterfaceReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceReferenceProperties object](#NetworkInterfaceReferenceProperties) | - - - -### BootDiagnostics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | Whether boot diagnostics should be enabled on the Virtual Machine. | -| storageUri | string | No | Uri of the storage account to use for placing the console output and screenshot. | - - - -### DiskEncryptionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| diskEncryptionKey | object | No | Specifies the location of the disk encryption key, which is a Key Vault Secret. - [KeyVaultSecretReference object](#KeyVaultSecretReference) | -| keyEncryptionKey | object | No | Specifies the location of the key encryption key in Key Vault. - [KeyVaultKeyReference object](#KeyVaultKeyReference) | -| enabled | boolean | No | Specifies whether disk encryption should be enabled on the virtual machine. | - - - -### VirtualHardDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Specifies the virtual hard disk's uri. | - - - -### ManagedDiskParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| storageAccountType | enum | No | Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - Standard_LRS or Premium_LRS | - - - -### AdditionalUnattendContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| passName | enum | No | The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem | -| componentName | enum | No | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup | -| settingName | enum | No | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands | -| content | string | No | 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. | - - - -### WinRMConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| listeners | array | No | The list of Windows Remote Management listeners - [WinRMListener object](#WinRMListener) | - - - -### SshConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicKeys | array | No | The list of SSH public keys used to authenticate with linux based VMs. - [SshPublicKey object](#SshPublicKey) | - - - -### VaultCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificateUrl | string | No | 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":""
    } | -| certificateStore | string | No | 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. | - - -     -### NetworkInterfaceReferenceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primary | boolean | No | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | - - - -### KeyVaultSecretReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| secretUrl | string | Yes | The URL referencing a secret in a Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the secret. - [SubResource object](#SubResource) | - - - -### KeyVaultKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyUrl | string | Yes | The URL referencing a key encryption key in Key Vault. | -| sourceVault | object | Yes | The relative URL of the Key Vault containing the key. - [SubResource object](#SubResource) | - - - -### WinRMListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**. - Http or Https | -| certificateUrl | string | No | 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":""
    } | - - -     -### SshPublicKey object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| path | string | No | 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 | -| keyData | string | No | 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). | - diff --git a/test/Resource/Expected/Compute/2017-12-01/virtualMachines/extensions.md b/test/Resource/Expected/Compute/2017-12-01/virtualMachines/extensions.md deleted file mode 100644 index f853e2b..0000000 --- a/test/Resource/Expected/Compute/2017-12-01/virtualMachines/extensions.md +++ /dev/null @@ -1,98 +0,0 @@ -# Microsoft.Compute/virtualMachines/extensions template reference -API Version: 2017-12-01 -## Template format - -To create a Microsoft.Compute/virtualMachines/extensions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Compute/virtualMachines/extensions", - "apiVersion": "2017-12-01", - "location": "string", - "tags": {}, - "properties": { - "forceUpdateTag": "string", - "publisher": "string", - "type": "string", - "typeHandlerVersion": "string", - "autoUpgradeMinorVersion": "boolean", - "settings": {}, - "protectedSettings": {}, - "instanceView": { - "name": "string", - "type": "string", - "typeHandlerVersion": "string", - "substatuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ], - "statuses": [ - { - "code": "string", - "level": "string", - "displayStatus": "string", - "message": "string", - "time": "string" - } - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - -     -### Microsoft.Compute/virtualMachines/extensions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Compute/virtualMachines/extensions | -| apiVersion | enum | Yes | 2017-12-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualMachineExtensionProperties object](#VirtualMachineExtensionProperties) | - - - -### VirtualMachineExtensionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceUpdateTag | string | No | How the extension handler should be forced to update even if the extension configuration has not changed. | -| publisher | string | No | The name of the extension handler publisher. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| autoUpgradeMinorVersion | boolean | No | 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. | -| settings | object | No | Json formatted public settings for the extension. | -| protectedSettings | object | No | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | -| instanceView | object | No | The virtual machine extension instance view. - [VirtualMachineExtensionInstanceView object](#VirtualMachineExtensionInstanceView) | - - - -### VirtualMachineExtensionInstanceView object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The virtual machine extension name. | -| type | string | No | Specifies the type of the extension; an example is "CustomScriptExtension". | -| typeHandlerVersion | string | No | Specifies the version of the script handler. | -| substatuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | -| statuses | array | No | The resource status information. - [InstanceViewStatus object](#InstanceViewStatus) | - - - -### InstanceViewStatus object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| code | string | No | The status code. | -| level | enum | No | The level code. - Info, Warning, Error | -| displayStatus | string | No | The short localizable label for the status. | -| message | string | No | The detailed status message, including for alerts and error messages. | -| time | string | No | The time of the status. | - diff --git a/test/Resource/Expected/ContainerRegistry/2016-06-27-preview/Microsoft.ContainerRegistry.json b/test/Resource/Expected/ContainerRegistry/2016-06-27-preview/Microsoft.ContainerRegistry.json deleted file mode 100644 index 2f2ced9..0000000 --- a/test/Resource/Expected/ContainerRegistry/2016-06-27-preview/Microsoft.ContainerRegistry.json +++ /dev/null @@ -1,119 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-06-27-preview/Microsoft.ContainerRegistry.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.ContainerRegistry", - "description": "Microsoft ContainerRegistry Resource Types", - "resourceDefinitions": { - "registries": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the container registry." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerRegistry/registries" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-27-preview" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource. This cannot be changed after the resource is created." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RegistryProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the container registry." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries" - } - }, - "definitions": { - "RegistryProperties": { - "type": "object", - "properties": { - "adminUserEnabled": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value that indicates whether the admin user is enabled. This value is false by default." - }, - "storageAccount": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry." - } - }, - "required": [ - "storageAccount" - ], - "description": "The properties of a container registry." - }, - "StorageAccountProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the storage account." - }, - "accessKey": { - "type": "string", - "description": "The access key to the storage account." - } - }, - "required": [ - "name", - "accessKey" - ], - "description": "The properties of a storage account for a container registry." - } - } -} diff --git a/test/Resource/Expected/ContainerRegistry/2016-06-27-preview/registries.md b/test/Resource/Expected/ContainerRegistry/2016-06-27-preview/registries.md deleted file mode 100644 index aacafdd..0000000 --- a/test/Resource/Expected/ContainerRegistry/2016-06-27-preview/registries.md +++ /dev/null @@ -1,53 +0,0 @@ -# Microsoft.ContainerRegistry/registries template reference -API Version: 2016-06-27-preview -## Template format - -To create a Microsoft.ContainerRegistry/registries resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerRegistry/registries", - "apiVersion": "2016-06-27-preview", - "location": "string", - "tags": {}, - "properties": { - "adminUserEnabled": "boolean", - "storageAccount": { - "name": "string", - "accessKey": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerRegistry/registries object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the container registry. | -| type | enum | Yes | Microsoft.ContainerRegistry/registries | -| apiVersion | enum | Yes | 2016-06-27-preview | -| location | string | Yes | The location of the resource. This cannot be changed after the resource is created. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the container registry. - [RegistryProperties object](#RegistryProperties) | - - - -### RegistryProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUserEnabled | boolean | No | The value that indicates whether the admin user is enabled. This value is false by default. | -| storageAccount | object | Yes | The properties of the storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry. - [StorageAccountProperties object](#StorageAccountProperties) | - - - -### StorageAccountProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the storage account. | -| accessKey | string | Yes | The access key to the storage account. | - diff --git a/test/Resource/Expected/ContainerRegistry/2017-03-01/Microsoft.ContainerRegistry.json b/test/Resource/Expected/ContainerRegistry/2017-03-01/Microsoft.ContainerRegistry.json deleted file mode 100644 index 4fe1217..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-03-01/Microsoft.ContainerRegistry.json +++ /dev/null @@ -1,152 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-03-01/Microsoft.ContainerRegistry.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.ContainerRegistry", - "description": "Microsoft ContainerRegistry Resource Types", - "resourceDefinitions": { - "registries": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the container registry." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerRegistry/registries" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags for the container registry." - }, - "location": { - "type": "string", - "description": "The location of the container registry. This cannot be changed after the resource is created." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU of the container registry." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RegistryPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties that the container registry will be created with." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "sku", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries" - } - }, - "definitions": { - "RegistryPropertiesCreateParameters": { - "type": "object", - "properties": { - "adminUserEnabled": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value that indicates whether the admin user is enabled." - }, - "storageAccount": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The parameters of a storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry." - } - }, - "required": [ - "storageAccount" - ], - "description": "The parameters for creating the properties of a container registry." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The SKU name of the container registry. Required for registry creation. Allowed value: Basic." - } - }, - "required": [ - "name" - ], - "description": "The SKU of a container registry." - }, - "StorageAccountParameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the storage account." - }, - "accessKey": { - "type": "string", - "description": "The access key to the storage account." - } - }, - "required": [ - "name", - "accessKey" - ], - "description": "The parameters of a storage account for a container registry." - } - } -} diff --git a/test/Resource/Expected/ContainerRegistry/2017-03-01/registries.md b/test/Resource/Expected/ContainerRegistry/2017-03-01/registries.md deleted file mode 100644 index 3ecc495..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-03-01/registries.md +++ /dev/null @@ -1,64 +0,0 @@ -# Microsoft.ContainerRegistry/registries template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.ContainerRegistry/registries resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerRegistry/registries", - "apiVersion": "2017-03-01", - "tags": {}, - "location": "string", - "sku": { - "name": "string" - }, - "properties": { - "adminUserEnabled": "boolean", - "storageAccount": { - "name": "string", - "accessKey": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerRegistry/registries object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the container registry. | -| type | enum | Yes | Microsoft.ContainerRegistry/registries | -| apiVersion | enum | Yes | 2017-03-01 | -| tags | object | No | The tags for the container registry. | -| location | string | Yes | The location of the container registry. This cannot be changed after the resource is created. | -| sku | object | Yes | The SKU of the container registry. - [Sku object](#Sku) | -| properties | object | Yes | The properties that the container registry will be created with. - [RegistryPropertiesCreateParameters object](#RegistryPropertiesCreateParameters) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The SKU name of the container registry. Required for registry creation. Allowed value: Basic. | - - - -### RegistryPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUserEnabled | boolean | No | The value that indicates whether the admin user is enabled. | -| storageAccount | object | Yes | The parameters of a storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry. - [StorageAccountParameters object](#StorageAccountParameters) | - - - -### StorageAccountParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the storage account. | -| accessKey | string | Yes | The access key to the storage account. | - diff --git a/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/Microsoft.ContainerRegistry.json b/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/Microsoft.ContainerRegistry.json deleted file mode 100644 index 5d6fb5c..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/Microsoft.ContainerRegistry.json +++ /dev/null @@ -1,509 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-06-01-preview/Microsoft.ContainerRegistry.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.ContainerRegistry", - "description": "Microsoft ContainerRegistry Resource Types", - "resourceDefinitions": { - "registries": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the container registry." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerRegistry/registries" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01-preview" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource. This cannot be changed after the resource is created." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU of the container registry." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RegistryProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the container registry." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/registries_replications_childResource" - }, - { - "$ref": "#/definitions/registries_webhooks_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "sku", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries" - }, - "registries_replications": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the replication." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerRegistry/registries/replications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01-preview" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource. This cannot be changed after the resource is created." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ReplicationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the replication." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries/replications" - }, - "registries_webhooks": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the webhook." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerRegistry/registries/webhooks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01-preview" - ] - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags for the webhook." - }, - "location": { - "type": "string", - "description": "The location of the webhook. This cannot be changed after the resource is created." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WebhookPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties that the webhook will be created with." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries/webhooks" - } - }, - "definitions": { - "registries_replications_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the replication." - }, - "type": { - "type": "string", - "enum": [ - "replications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01-preview" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource. This cannot be changed after the resource is created." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ReplicationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the replication." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries/replications" - }, - "registries_webhooks_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the webhook." - }, - "type": { - "type": "string", - "enum": [ - "webhooks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01-preview" - ] - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags for the webhook." - }, - "location": { - "type": "string", - "description": "The location of the webhook. This cannot be changed after the resource is created." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WebhookPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties that the webhook will be created with." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries/webhooks" - }, - "RegistryProperties": { - "type": "object", - "properties": { - "adminUserEnabled": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value that indicates whether the admin user is enabled." - }, - "storageAccount": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the storage account for the container registry. Only applicable to Basic SKU." - } - }, - "description": "The properties of a container registry." - }, - "ReplicationProperties": { - "type": "object", - "properties": {}, - "description": "The properties of a replication." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "Managed_Basic", - "Managed_Standard", - "Managed_Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU name of the container registry. Required for registry creation." - } - }, - "required": [ - "name" - ], - "description": "The SKU of a container registry." - }, - "StorageAccountProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The resource ID of the storage account." - } - }, - "required": [ - "id" - ], - "description": "The properties of a storage account for a container registry. Only applicable to Basic SKU." - }, - "WebhookPropertiesCreateParameters": { - "type": "object", - "properties": { - "serviceUri": { - "type": "string", - "description": "The service URI for the webhook to post notifications." - }, - "customHeaders": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Custom headers that will be added to the webhook notifications." - }, - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the webhook at the time the operation was called." - }, - "scope": { - "type": "string", - "description": "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." - }, - "actions": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "push", - "delete" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of actions that trigger the webhook to post notifications." - } - }, - "required": [ - "serviceUri", - "actions" - ], - "description": "The parameters for creating the properties of a webhook." - } - } -} diff --git a/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries.md b/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries.md deleted file mode 100644 index 7195c2f..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries.md +++ /dev/null @@ -1,64 +0,0 @@ -# Microsoft.ContainerRegistry/registries template reference -API Version: 2017-06-01-preview -## Template format - -To create a Microsoft.ContainerRegistry/registries resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerRegistry/registries", - "apiVersion": "2017-06-01-preview", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "adminUserEnabled": "boolean", - "storageAccount": { - "id": "string" - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerRegistry/registries object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the container registry. | -| type | enum | Yes | Microsoft.ContainerRegistry/registries | -| apiVersion | enum | Yes | 2017-06-01-preview | -| location | string | Yes | The location of the resource. This cannot be changed after the resource is created. | -| tags | object | No | The tags of the resource. | -| sku | object | Yes | The SKU of the container registry. - [Sku object](#Sku) | -| properties | object | Yes | The properties of the container registry. - [RegistryProperties object](#RegistryProperties) | -| resources | array | No | [webhooks](./registries/webhooks.md) [replications](./registries/replications.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The SKU name of the container registry. Required for registry creation. - Basic, Managed_Basic, Managed_Standard, Managed_Premium | - - - -### RegistryProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUserEnabled | boolean | No | The value that indicates whether the admin user is enabled. | -| storageAccount | object | No | The properties of the storage account for the container registry. Only applicable to Basic SKU. - [StorageAccountProperties object](#StorageAccountProperties) | - - - -### StorageAccountProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | The resource ID of the storage account. | - diff --git a/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries/replications.md b/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries/replications.md deleted file mode 100644 index 098b437..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries/replications.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.ContainerRegistry/registries/replications template reference -API Version: 2017-06-01-preview -## Template format - -To create a Microsoft.ContainerRegistry/registries/replications resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerRegistry/registries/replications", - "apiVersion": "2017-06-01-preview", - "location": "string", - "tags": {}, - "properties": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerRegistry/registries/replications object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the replication. | -| type | enum | Yes | Microsoft.ContainerRegistry/registries/replications | -| apiVersion | enum | Yes | 2017-06-01-preview | -| location | string | Yes | The location of the resource. This cannot be changed after the resource is created. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the replication. - [ReplicationProperties object](#ReplicationProperties) | - diff --git a/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries/webhooks.md b/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries/webhooks.md deleted file mode 100644 index 654895a..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-06-01-preview/registries/webhooks.md +++ /dev/null @@ -1,50 +0,0 @@ -# Microsoft.ContainerRegistry/registries/webhooks template reference -API Version: 2017-06-01-preview -## Template format - -To create a Microsoft.ContainerRegistry/registries/webhooks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerRegistry/registries/webhooks", - "apiVersion": "2017-06-01-preview", - "tags": {}, - "location": "string", - "properties": { - "serviceUri": "string", - "customHeaders": {}, - "status": "string", - "scope": "string", - "actions": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerRegistry/registries/webhooks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the webhook. | -| type | enum | Yes | Microsoft.ContainerRegistry/registries/webhooks | -| apiVersion | enum | Yes | 2017-06-01-preview | -| tags | object | No | The tags for the webhook. | -| location | string | Yes | The location of the webhook. This cannot be changed after the resource is created. | -| properties | object | Yes | The properties that the webhook will be created with. - [WebhookPropertiesCreateParameters object](#WebhookPropertiesCreateParameters) | - - - -### WebhookPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceUri | string | Yes | The service URI for the webhook to post notifications. | -| customHeaders | object | No | Custom headers that will be added to the webhook notifications. | -| status | enum | No | The status of the webhook at the time the operation was called. - enabled or disabled | -| scope | string | No | 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. | -| actions | array | Yes | The list of actions that trigger the webhook to post notifications. - push or delete | - diff --git a/test/Resource/Expected/ContainerRegistry/2017-10-01/Microsoft.ContainerRegistry.json b/test/Resource/Expected/ContainerRegistry/2017-10-01/Microsoft.ContainerRegistry.json deleted file mode 100644 index 879e18b..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-10-01/Microsoft.ContainerRegistry.json +++ /dev/null @@ -1,509 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-10-01/Microsoft.ContainerRegistry.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.ContainerRegistry", - "description": "Microsoft ContainerRegistry Resource Types", - "resourceDefinitions": { - "registries": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the container registry." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerRegistry/registries" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource. This cannot be changed after the resource is created." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU of the container registry." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RegistryProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the container registry." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/registries_replications_childResource" - }, - { - "$ref": "#/definitions/registries_webhooks_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "sku", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries" - }, - "registries_replications": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the replication." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerRegistry/registries/replications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource. This cannot be changed after the resource is created." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ReplicationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the replication." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries/replications" - }, - "registries_webhooks": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the webhook." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.ContainerRegistry/registries/webhooks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags for the webhook." - }, - "location": { - "type": "string", - "description": "The location of the webhook. This cannot be changed after the resource is created." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WebhookPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties that the webhook will be created with." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries/webhooks" - } - }, - "definitions": { - "registries_replications_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the replication." - }, - "type": { - "type": "string", - "enum": [ - "replications" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource. This cannot be changed after the resource is created." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ReplicationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the replication." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries/replications" - }, - "registries_webhooks_childResource": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "pattern": "^[a-zA-Z0-9]*$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of the webhook." - }, - "type": { - "type": "string", - "enum": [ - "webhooks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags for the webhook." - }, - "location": { - "type": "string", - "description": "The location of the webhook. This cannot be changed after the resource is created." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WebhookPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties that the webhook will be created with." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.ContainerRegistry/registries/webhooks" - }, - "RegistryProperties": { - "type": "object", - "properties": { - "adminUserEnabled": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value that indicates whether the admin user is enabled." - }, - "storageAccount": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the storage account for the container registry. Only applicable to Classic SKU." - } - }, - "description": "The properties of a container registry." - }, - "ReplicationProperties": { - "type": "object", - "properties": {}, - "description": "The properties of a replication." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Classic", - "Basic", - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU name of the container registry. Required for registry creation." - } - }, - "required": [ - "name" - ], - "description": "The SKU of a container registry." - }, - "StorageAccountProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The resource ID of the storage account." - } - }, - "required": [ - "id" - ], - "description": "The properties of a storage account for a container registry. Only applicable to Classic SKU." - }, - "WebhookPropertiesCreateParameters": { - "type": "object", - "properties": { - "serviceUri": { - "type": "string", - "description": "The service URI for the webhook to post notifications." - }, - "customHeaders": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Custom headers that will be added to the webhook notifications." - }, - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the webhook at the time the operation was called." - }, - "scope": { - "type": "string", - "description": "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." - }, - "actions": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "push", - "delete" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of actions that trigger the webhook to post notifications." - } - }, - "required": [ - "serviceUri", - "actions" - ], - "description": "The parameters for creating the properties of a webhook." - } - } -} diff --git a/test/Resource/Expected/ContainerRegistry/2017-10-01/registries.md b/test/Resource/Expected/ContainerRegistry/2017-10-01/registries.md deleted file mode 100644 index 7052d5f..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-10-01/registries.md +++ /dev/null @@ -1,64 +0,0 @@ -# Microsoft.ContainerRegistry/registries template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.ContainerRegistry/registries resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerRegistry/registries", - "apiVersion": "2017-10-01", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "adminUserEnabled": "boolean", - "storageAccount": { - "id": "string" - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerRegistry/registries object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the container registry. | -| type | enum | Yes | Microsoft.ContainerRegistry/registries | -| apiVersion | enum | Yes | 2017-10-01 | -| location | string | Yes | The location of the resource. This cannot be changed after the resource is created. | -| tags | object | No | The tags of the resource. | -| sku | object | Yes | The SKU of the container registry. - [Sku object](#Sku) | -| properties | object | Yes | The properties of the container registry. - [RegistryProperties object](#RegistryProperties) | -| resources | array | No | [webhooks](./registries/webhooks.md) [replications](./registries/replications.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The SKU name of the container registry. Required for registry creation. - Classic, Basic, Standard, Premium | - - - -### RegistryProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| adminUserEnabled | boolean | No | The value that indicates whether the admin user is enabled. | -| storageAccount | object | No | The properties of the storage account for the container registry. Only applicable to Classic SKU. - [StorageAccountProperties object](#StorageAccountProperties) | - - - -### StorageAccountProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | The resource ID of the storage account. | - diff --git a/test/Resource/Expected/ContainerRegistry/2017-10-01/registries/replications.md b/test/Resource/Expected/ContainerRegistry/2017-10-01/registries/replications.md deleted file mode 100644 index ee55396..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-10-01/registries/replications.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.ContainerRegistry/registries/replications template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.ContainerRegistry/registries/replications resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerRegistry/registries/replications", - "apiVersion": "2017-10-01", - "location": "string", - "tags": {}, - "properties": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerRegistry/registries/replications object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the replication. | -| type | enum | Yes | Microsoft.ContainerRegistry/registries/replications | -| apiVersion | enum | Yes | 2017-10-01 | -| location | string | Yes | The location of the resource. This cannot be changed after the resource is created. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the replication. - [ReplicationProperties object](#ReplicationProperties) | - diff --git a/test/Resource/Expected/ContainerRegistry/2017-10-01/registries/webhooks.md b/test/Resource/Expected/ContainerRegistry/2017-10-01/registries/webhooks.md deleted file mode 100644 index 14a2a7d..0000000 --- a/test/Resource/Expected/ContainerRegistry/2017-10-01/registries/webhooks.md +++ /dev/null @@ -1,50 +0,0 @@ -# Microsoft.ContainerRegistry/registries/webhooks template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.ContainerRegistry/registries/webhooks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ContainerRegistry/registries/webhooks", - "apiVersion": "2017-10-01", - "tags": {}, - "location": "string", - "properties": { - "serviceUri": "string", - "customHeaders": {}, - "status": "string", - "scope": "string", - "actions": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ContainerRegistry/registries/webhooks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the webhook. | -| type | enum | Yes | Microsoft.ContainerRegistry/registries/webhooks | -| apiVersion | enum | Yes | 2017-10-01 | -| tags | object | No | The tags for the webhook. | -| location | string | Yes | The location of the webhook. This cannot be changed after the resource is created. | -| properties | object | Yes | The properties that the webhook will be created with. - [WebhookPropertiesCreateParameters object](#WebhookPropertiesCreateParameters) | - - - -### WebhookPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceUri | string | Yes | The service URI for the webhook to post notifications. | -| customHeaders | object | No | Custom headers that will be added to the webhook notifications. | -| status | enum | No | The status of the webhook at the time the operation was called. - enabled or disabled | -| scope | string | No | 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. | -| actions | array | Yes | The list of actions that trigger the webhook to post notifications. - push or delete | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/Microsoft.CustomerInsights.json b/test/Resource/Expected/CustomerInsights/2017-01-01/Microsoft.CustomerInsights.json deleted file mode 100644 index 00c24a9..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/Microsoft.CustomerInsights.json +++ /dev/null @@ -1,3085 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-01-01/Microsoft.CustomerInsights.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.CustomerInsights", - "description": "Microsoft CustomerInsights Resource Types", - "resourceDefinitions": { - "hubs": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/HubPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/hubs_profiles_childResource" - }, - { - "$ref": "#/definitions/hubs_interactions_childResource" - }, - { - "$ref": "#/definitions/hubs_relationships_childResource" - }, - { - "$ref": "#/definitions/hubs_relationshipLinks_childResource" - }, - { - "$ref": "#/definitions/hubs_authorizationPolicies_childResource" - }, - { - "$ref": "#/definitions/hubs_connectors_childResource" - }, - { - "$ref": "#/definitions/hubs_kpi_childResource" - }, - { - "$ref": "#/definitions/hubs_views_childResource" - }, - { - "$ref": "#/definitions/hubs_links_childResource" - }, - { - "$ref": "#/definitions/hubs_roleAssignments_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs" - }, - "hubs_authorizationPolicies": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/authorizationPolicies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/authorizationPolicies" - }, - "hubs_connectors": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/connectors" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/Connector" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/hubs_connectors_mappings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/connectors" - }, - "hubs_connectors_mappings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/connectors/mappings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMapping" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/connectors/mappings" - }, - "hubs_interactions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/interactions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InteractionTypeDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/interactions" - }, - "hubs_kpi": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/kpi" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/KpiDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/kpi" - }, - "hubs_links": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/links" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LinkDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/links" - }, - "hubs_profiles": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/profiles" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProfileTypeDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/profiles" - }, - "hubs_relationshipLinks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/relationshipLinks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelationshipLinkDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/relationshipLinks" - }, - "hubs_relationships": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/relationships" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelationshipDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/relationships" - }, - "hubs_roleAssignments": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/roleAssignments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoleAssignment" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/roleAssignments" - }, - "hubs_views": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/views" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/View" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/views" - } - }, - "definitions": { - "AssignmentPrincipal": { - "type": "object", - "properties": { - "principalId": { - "type": "string", - "description": "The principal id being assigned to." - }, - "principalType": { - "type": "string", - "description": "The Type of the principal ID." - }, - "principalMetadata": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Other metadata for the principal." - } - }, - "required": [ - "principalId", - "principalType" - ], - "description": "The AssignmentPrincipal" - }, - "AuthorizationPolicy": { - "type": "object", - "properties": { - "permissions": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Read", - "Write", - "Manage" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The permissions associated with the policy." - }, - "primaryKey": { - "type": "string", - "description": "Primary key assiciated with the policy." - }, - "secondaryKey": { - "type": "string", - "description": "Secondary key assiciated with the policy." - } - }, - "required": [ - "permissions" - ], - "description": "The authorization policy." - }, - "Connector": { - "type": "object", - "properties": { - "connectorName": { - "type": "string", - "description": "Name of the connector." - }, - "connectorType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "CRM", - "AzureBlob", - "Salesforce", - "ExchangeOnline", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of connector." - }, - "displayName": { - "type": "string", - "description": "Display name of the connector." - }, - "description": { - "type": "string", - "description": "Description of the connector." - }, - "connectorProperties": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": {} - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The connector properties." - }, - "isInternal": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If this is an internal connector." - } - }, - "required": [ - "connectorType", - "connectorProperties" - ], - "description": "Properties of connector." - }, - "ConnectorMapping": { - "type": "object", - "properties": { - "connectorType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "CRM", - "AzureBlob", - "Salesforce", - "ExchangeOnline", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of connector." - }, - "entityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Defines which entity type the file should map to." - }, - "entityTypeName": { - "type": "string", - "description": "The mapping entity name." - }, - "displayName": { - "type": "string", - "description": "Display name for the connector mapping." - }, - "description": { - "type": "string", - "description": "The description of the connector mapping." - }, - "mappingProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the mapping." - } - }, - "required": [ - "entityType", - "entityTypeName", - "mappingProperties" - ], - "description": "The connector mapping definition." - }, - "ConnectorMappingAvailability": { - "type": "object", - "properties": { - "frequency": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The frequency to update." - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interval of the given frequency to use." - } - }, - "required": [ - "interval" - ], - "description": "Connector mapping property availability." - }, - "ConnectorMappingCompleteOperation": { - "type": "object", - "properties": { - "completionOperationType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "DoNothing", - "DeleteFile", - "MoveFile" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of completion operation." - }, - "destinationFolder": { - "type": "string", - "description": "The destination folder where files will be moved to once the import is done." - } - }, - "description": "The complete operation." - }, - "ConnectorMappingErrorManagement": { - "type": "object", - "properties": { - "errorManagementType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "RejectAndContinue", - "StopImport", - "RejectUntilLimit" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of error management to use for the mapping." - }, - "errorLimit": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The error limit allowed while importing data." - } - }, - "required": [ - "errorManagementType" - ], - "description": "The error mangement." - }, - "ConnectorMappingFormat": { - "type": "object", - "properties": { - "formatType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TextFormat" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type mapping format." - }, - "columnDelimiter": { - "type": "string", - "description": "The character that signifies a break between columns." - }, - "acceptLanguage": { - "type": "string", - "description": "The oData language." - }, - "quoteCharacter": { - "type": "string", - "description": "Quote character, used to indicate enquoted fields." - }, - "quoteEscapeCharacter": { - "type": "string", - "description": "Escape character for quotes, can be the same as the quoteCharacter." - }, - "arraySeparator": { - "type": "string", - "description": "Character separating array elements." - } - }, - "required": [ - "formatType" - ], - "description": "Connector mapping property format." - }, - "ConnectorMappingProperties": { - "type": "object", - "properties": { - "folderPath": { - "type": "string", - "description": "The folder path for the mapping." - }, - "fileFilter": { - "type": "string", - "description": "The file filter for the mapping." - }, - "hasHeader": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the file contains a header or not." - }, - "errorManagement": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingErrorManagement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The error management setting for the mapping." - }, - "format": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The format of mapping property." - }, - "availability": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingAvailability" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The availability of mapping property." - }, - "structure": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ConnectorMappingStructure" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ingestion mapping information at property level." - }, - "completeOperation": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingCompleteOperation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The operation after import is done." - } - }, - "required": [ - "errorManagement", - "format", - "availability", - "structure", - "completeOperation" - ], - "description": "The connector mapping properties." - }, - "ConnectorMappingStructure": { - "type": "object", - "properties": { - "propertyName": { - "type": "string", - "description": "The property name of the mapping entity." - }, - "columnName": { - "type": "string", - "description": "The column name of the import file." - }, - "customFormatSpecifier": { - "type": "string", - "description": "Custom format specifier for input parsing." - }, - "isEncrypted": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if the column is encrypted." - } - }, - "required": [ - "propertyName", - "columnName" - ], - "description": "Connector mapping property structure." - }, - "DataSource": { - "type": "object", - "properties": {}, - "description": "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." - }, - "HubBillingInfoFormat": { - "type": "object", - "properties": { - "skuName": { - "type": "string", - "description": "The sku name." - }, - "minUnits": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 10 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions." - }, - "maxUnits": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 10 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions." - } - }, - "description": "Hub billing info." - }, - "HubPropertiesFormat": { - "type": "object", - "properties": { - "tenantFeatures": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "hubBillingInfo": { - "oneOf": [ - { - "$ref": "#/definitions/HubBillingInfoFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Billing settings of the hub." - } - }, - "description": "Properties of hub." - }, - "hubs_authorizationPolicies_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizationPolicies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/authorizationPolicies" - }, - "hubs_connectors_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "connectors" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/Connector" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/connectors" - }, - "hubs_connectors_mappings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "mappings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMapping" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/connectors/mappings" - }, - "hubs_interactions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "interactions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InteractionTypeDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/interactions" - }, - "hubs_kpi_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "kpi" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/KpiDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/kpi" - }, - "hubs_links_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "links" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LinkDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/links" - }, - "hubs_profiles_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "profiles" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProfileTypeDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/profiles" - }, - "hubs_relationshipLinks_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "relationshipLinks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelationshipLinkDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/relationshipLinks" - }, - "hubs_relationships_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "relationships" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelationshipDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/relationships" - }, - "hubs_roleAssignments_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "roleAssignments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoleAssignment" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/roleAssignments" - }, - "hubs_views_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "views" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-01-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/View" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/views" - }, - "InteractionTypeDefinition": { - "type": "object", - "properties": { - "attributes": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The attributes for the Type." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the property." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display names for the property." - }, - "localizedAttributes": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Any custom localized attributes for the Type." - }, - "smallImage": { - "type": "string", - "description": "Small Image associated with the Property or EntityType." - }, - "mediumImage": { - "type": "string", - "description": "Medium Image associated with the Property or EntityType." - }, - "largeImage": { - "type": "string", - "description": "Large Image associated with the Property or EntityType." - }, - "apiEntitySetName": { - "type": "string", - "description": "The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object." - }, - "entityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of entity." - }, - "fields": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PropertyDefinition" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the Profile." - }, - "instancesCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The instance count." - }, - "schemaItemTypeLink": { - "type": "string", - "description": "The schema org link. This helps ACI identify and suggest semantic models." - }, - "timestampFieldName": { - "type": "string", - "description": "The timestamp property name. Represents the time when the interaction or profile update happened." - }, - "typeName": { - "type": "string", - "description": "The name of the entity." - }, - "idPropertyNames": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The id property names. Properties which uniquely identify an interaction instance." - }, - "participantProfiles": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Participant" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Profiles that participated in the interaction." - }, - "primaryParticipantProfilePropertyName": { - "type": "string", - "description": "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." - }, - "defaultDataSource": { - "oneOf": [ - { - "$ref": "#/definitions/DataSource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default data source is specifically used in cases where data source is not specified in an instance." - }, - "isActivity": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "description": "The Interaction Type Definition" - }, - "KpiAlias": { - "type": "object", - "properties": { - "aliasName": { - "type": "string", - "description": "KPI alias name." - }, - "expression": { - "type": "string", - "description": "The expression." - } - }, - "required": [ - "aliasName", - "expression" - ], - "description": "The KPI alias." - }, - "KpiDefinition": { - "type": "object", - "properties": { - "entityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The mapping entity type." - }, - "entityTypeName": { - "type": "string", - "description": "The mapping entity name." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the KPI." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized description for the KPI." - }, - "calculationWindow": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Lifetime", - "Hour", - "Day", - "Week", - "Month" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The calculation window." - }, - "calculationWindowFieldName": { - "type": "string", - "description": "Name of calculation window field." - }, - "function": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Sum", - "Avg", - "Min", - "Max", - "Last", - "Count", - "None", - "CountDistinct" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The computation function for the KPI." - }, - "expression": { - "type": "string", - "description": "The computation expression for the KPI." - }, - "unit": { - "type": "string", - "description": "The unit of measurement for the KPI." - }, - "filter": { - "type": "string", - "description": "The filter expression for the KPI." - }, - "groupBy": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the group by properties for the KPI." - }, - "thresHolds": { - "oneOf": [ - { - "$ref": "#/definitions/KpiThresholds" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The KPI thresholds." - }, - "aliases": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/KpiAlias" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The aliases." - }, - "extracts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/KpiExtract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The KPI extracts." - } - }, - "required": [ - "entityType", - "entityTypeName", - "calculationWindow", - "function", - "expression" - ], - "description": "Defines the KPI Threshold limits." - }, - "KpiExtract": { - "type": "object", - "properties": { - "extractName": { - "type": "string", - "description": "KPI extract name." - }, - "expression": { - "type": "string", - "description": "The expression." - } - }, - "required": [ - "extractName", - "expression" - ], - "description": "The KPI extract." - }, - "KpiThresholds": { - "type": "object", - "properties": { - "lowerLimit": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The lower threshold limit." - }, - "upperLimit": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The upper threshold limit." - }, - "increasingKpi": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether or not the KPI is an increasing KPI." - } - }, - "required": [ - "lowerLimit", - "upperLimit", - "increasingKpi" - ], - "description": "Defines the KPI Threshold limits." - }, - "LinkDefinition": { - "type": "object", - "properties": { - "sourceInteractionType": { - "type": "string", - "description": "Name of the source Interaction Type." - }, - "targetProfileType": { - "type": "string", - "description": "Name of the target Profile Type." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the Link." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the Link." - }, - "mappings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/TypePropertiesMapping" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The set of properties mappings between the source and target Types." - }, - "participantPropertyReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantPropertyReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties that represent the participating profile." - }, - "referenceOnly": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicating whether the link is reference only link. This flag is ingored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles." - }, - "operationType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Upsert", - "Delete" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only." - } - }, - "required": [ - "sourceInteractionType", - "targetProfileType", - "participantPropertyReferences" - ], - "description": "The definition of Link." - }, - "Participant": { - "type": "object", - "properties": { - "profileTypeName": { - "type": "string", - "description": "Profile type name." - }, - "participantPropertyReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantPropertyReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The property references." - }, - "participantName": { - "type": "string", - "description": "Participant name." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions." - }, - "role": { - "type": "string", - "description": "The role that the participant is playing in the interaction." - } - }, - "required": [ - "profileTypeName", - "participantPropertyReferences", - "participantName" - ], - "description": "Describes a profile type participating in an interaction." - }, - "ParticipantPropertyReference": { - "type": "object", - "properties": { - "interactionPropertyName": { - "type": "string", - "description": "The interaction property that maps to the profile property." - }, - "profilePropertyName": { - "type": "string", - "description": "The profile property that maps to the interaction property." - } - }, - "required": [ - "interactionPropertyName", - "profilePropertyName" - ], - "description": "The participant property reference." - }, - "ProfileEnumValidValuesFormat": { - "type": "object", - "properties": { - "value": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integer value of the enum member." - }, - "localizedValueNames": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized names of the enum member." - } - }, - "description": "Valid enum values in case of an enum property." - }, - "ProfileTypeDefinition": { - "type": "object", - "properties": { - "attributes": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The attributes for the Type." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the property." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display names for the property." - }, - "localizedAttributes": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Any custom localized attributes for the Type." - }, - "smallImage": { - "type": "string", - "description": "Small Image associated with the Property or EntityType." - }, - "mediumImage": { - "type": "string", - "description": "Medium Image associated with the Property or EntityType." - }, - "largeImage": { - "type": "string", - "description": "Large Image associated with the Property or EntityType." - }, - "apiEntitySetName": { - "type": "string", - "description": "The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object." - }, - "entityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of entity." - }, - "fields": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PropertyDefinition" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the Profile." - }, - "instancesCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The instance count." - }, - "schemaItemTypeLink": { - "type": "string", - "description": "The schema org link. This helps ACI identify and suggest semantic models." - }, - "timestampFieldName": { - "type": "string", - "description": "The timestamp property name. Represents the time when the interaction or profile update happened." - }, - "typeName": { - "type": "string", - "description": "The name of the entity." - }, - "strongIds": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/StrongId" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The strong IDs." - } - }, - "description": "The profile type definition." - }, - "PropertyDefinition": { - "type": "object", - "properties": { - "arrayValueSeparator": { - "type": "string", - "description": "Array value separator for properties with isArray set." - }, - "enumValidValues": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ProfileEnumValidValuesFormat" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Describes valid values for an enum property." - }, - "fieldName": { - "type": "string", - "description": "Name of the property." - }, - "fieldType": { - "type": "string", - "description": "Type of the property." - }, - "isArray": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if the property is actually an array of the fieldType above on the data api." - }, - "isEnum": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if the property is an enum." - }, - "isFlagEnum": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if the property is an flag enum." - }, - "isImage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the property is an Image." - }, - "isLocalizedString": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the property is a localized string." - }, - "isName": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the property is a name or a part of name." - }, - "isRequired": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field." - }, - "propertyId": { - "type": "string", - "description": "The ID associated with the property." - }, - "schemaItemPropLink": { - "type": "string", - "description": "URL encoded schema.org item prop link for the property." - }, - "maxLength": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Max length of string. Used only if type is string." - }, - "isAvailableInGraph": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether property is available in graph or not." - } - }, - "required": [ - "fieldName", - "fieldType" - ], - "description": "Property definition." - }, - "RelationshipDefinition": { - "type": "object", - "properties": { - "cardinality": { - "oneOf": [ - { - "type": "string", - "enum": [ - "OneToOne", - "OneToMany", - "ManyToMany" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Relationship Cardinality." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the Relationship." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the Relationship." - }, - "expiryDateTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The expiry date time in UTC." - }, - "fields": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PropertyDefinition" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the Relationship." - }, - "lookupMappings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RelationshipTypeMapping" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Optional property to be used to map fields in profile to their strong ids in related profile." - }, - "profileType": { - "type": "string", - "description": "Profile type." - }, - "relatedProfileType": { - "type": "string", - "description": "Related profile being referenced." - } - }, - "required": [ - "profileType", - "relatedProfileType" - ], - "description": "The definition of Relationship." - }, - "RelationshipLinkDefinition": { - "type": "object", - "properties": { - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the Relationship Link." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the Relationship Link." - }, - "interactionType": { - "type": "string", - "description": "The InteractionType associated with the Relationship Link." - }, - "mappings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RelationshipLinkFieldMapping" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The mappings between Interaction and Relationship fields." - }, - "profilePropertyReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantPropertyReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The property references for the Profile of the Relationship." - }, - "relatedProfilePropertyReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantPropertyReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The property references for the Related Profile of the Relationship." - }, - "relationshipName": { - "type": "string", - "description": "The Relationship associated with the Link." - } - }, - "required": [ - "interactionType", - "profilePropertyReferences", - "relatedProfilePropertyReferences", - "relationshipName" - ], - "description": "The definition of relationship link." - }, - "RelationshipLinkFieldMapping": { - "type": "object", - "properties": { - "interactionFieldName": { - "type": "string", - "description": "The field name on the Interaction Type." - }, - "linkType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UpdateAlways", - "CopyIfNull" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Link type." - }, - "relationshipFieldName": { - "type": "string", - "description": "The field name on the Relationship metadata." - } - }, - "required": [ - "interactionFieldName", - "relationshipFieldName" - ], - "description": "The fields mapping for Relationships." - }, - "RelationshipTypeFieldMapping": { - "type": "object", - "properties": { - "profileFieldName": { - "type": "string", - "description": "Specifies the fieldName in profile." - }, - "relatedProfileKeyProperty": { - "type": "string", - "description": "Specifies the KeyProperty (from StrongId) of the related profile." - } - }, - "required": [ - "profileFieldName", - "relatedProfileKeyProperty" - ], - "description": "Map a field of profile to its corresponding StrongId in Related Profile." - }, - "RelationshipTypeMapping": { - "type": "object", - "properties": { - "fieldMappings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RelationshipTypeFieldMapping" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well." - } - }, - "required": [ - "fieldMappings" - ], - "description": "Maps fields in Profile to their corresponding StrongIds in Related Profile." - }, - "ResourceSetDescription": { - "type": "object", - "properties": { - "elements": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The elements included in the set." - }, - "exceptions": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The elements that are not included in the set, in case elements contains '*' indicating 'all'." - } - }, - "description": "The resource set description." - }, - "RoleAssignment": { - "type": "object", - "properties": { - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display names for the metadata." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized description for the metadata." - }, - "role": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Admin", - "Reader", - "ManageAdmin", - "ManageReader", - "DataAdmin", - "DataReader" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of roles." - }, - "principals": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AssignmentPrincipal" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The principals being assigned to." - }, - "profiles": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Profiles set for the assignment." - }, - "interactions": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Interactions set for the assignment." - }, - "links": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Links set for the assignment." - }, - "kpis": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Kpis set for the assignment." - }, - "sasPolicies": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sas Policies set for the assignment." - }, - "connectors": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connectors set for the assignment." - }, - "views": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Views set for the assignment." - }, - "relationshipLinks": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Role assignments set for the relationship links." - }, - "relationships": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Role assignments set for the relationships." - }, - "widgetTypes": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Widget types set for the assignment." - }, - "roleAssignments": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Role assignments set for the assignment." - }, - "conflationPolicies": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Widget types set for the assignment." - }, - "segments": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Role assignments set for the assignment." - } - }, - "required": [ - "role", - "principals" - ], - "description": "The Role Assignment definition." - }, - "StrongId": { - "type": "object", - "properties": { - "keyPropertyNames": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties which make up the unique ID." - }, - "strongIdName": { - "type": "string", - "description": "The Name identifying the strong ID." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions." - } - }, - "required": [ - "keyPropertyNames", - "strongIdName" - ], - "description": "Property/Properties which represent a unique ID." - }, - "TypePropertiesMapping": { - "type": "object", - "properties": { - "interactionTypePropertyName": { - "type": "string", - "description": " Property name on the source Interaction Type." - }, - "profileTypePropertyName": { - "type": "string", - "description": "Property name on the target Profile Type." - }, - "isProfileTypeId": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Flag to indicate whether the Profile Type property is an id on the Profile Type." - }, - "linkType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UpdateAlways", - "CopyIfNull" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Link type." - } - }, - "required": [ - "interactionTypePropertyName", - "profileTypePropertyName" - ], - "description": "Metadata for a Link's property mapping." - }, - "View": { - "type": "object", - "properties": { - "userId": { - "type": "string", - "description": "the user ID." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the view." - }, - "definition": { - "type": "string", - "description": "View definition." - } - }, - "required": [ - "definition" - ], - "description": "The view in Customer 360 web application." - } - } -} diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs.md deleted file mode 100644 index c6e6fbc..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs.md +++ /dev/null @@ -1,57 +0,0 @@ -# Microsoft.CustomerInsights/hubs template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs", - "apiVersion": "2017-01-01", - "location": "string", - "tags": {}, - "properties": { - "tenantFeatures": "integer", - "hubBillingInfo": { - "skuName": "string", - "minUnits": "integer", - "maxUnits": "integer" - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs | -| apiVersion | enum | Yes | 2017-01-01 | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [HubPropertiesFormat object](#HubPropertiesFormat) | -| resources | array | No | [roleAssignments](./hubs/roleAssignments.md) [links](./hubs/links.md) [views](./hubs/views.md) [kpi](./hubs/kpi.md) [connectors](./hubs/connectors.md) [authorizationPolicies](./hubs/authorizationPolicies.md) [relationshipLinks](./hubs/relationshipLinks.md) [relationships](./hubs/relationships.md) [interactions](./hubs/interactions.md) [profiles](./hubs/profiles.md) | - - - -### HubPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| tenantFeatures | integer | No | 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. | -| hubBillingInfo | object | No | Billing settings of the hub. - [HubBillingInfoFormat object](#HubBillingInfoFormat) | - - - -### HubBillingInfoFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| skuName | string | No | The sku name. | -| minUnits | integer | No | The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. | -| maxUnits | integer | No | The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/authorizationPolicies.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/authorizationPolicies.md deleted file mode 100644 index 2638d55..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/authorizationPolicies.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.CustomerInsights/hubs/authorizationPolicies template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/authorizationPolicies resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/authorizationPolicies", - "apiVersion": "2017-01-01", - "properties": { - "permissions": [ - "string" - ], - "primaryKey": "string", - "secondaryKey": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/authorizationPolicies object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/authorizationPolicies | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [AuthorizationPolicy object](#AuthorizationPolicy) | - - - -### AuthorizationPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| permissions | array | Yes | The permissions associated with the policy. - Read, Write, Manage | -| primaryKey | string | No | Primary key assiciated with the policy. | -| secondaryKey | string | No | Secondary key assiciated with the policy. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/connectors.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/connectors.md deleted file mode 100644 index f7f3dca..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/connectors.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.CustomerInsights/hubs/connectors template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/connectors resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/connectors", - "apiVersion": "2017-01-01", - "properties": { - "connectorName": "string", - "connectorType": "string", - "displayName": "string", - "description": "string", - "connectorProperties": {}, - "isInternal": "boolean" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/connectors object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/connectors | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [Connector object](#Connector) | -| resources | array | No | [mappings](./connectors/mappings.md) | - - - -### Connector object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| connectorName | string | No | Name of the connector. | -| connectorType | enum | Yes | Type of connector. - None, CRM, AzureBlob, Salesforce, ExchangeOnline, Outbound | -| displayName | string | No | Display name of the connector. | -| description | string | No | Description of the connector. | -| connectorProperties | object | Yes | The connector properties. | -| isInternal | boolean | No | If this is an internal connector. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/connectors/mappings.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/connectors/mappings.md deleted file mode 100644 index 4e65f1f..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/connectors/mappings.md +++ /dev/null @@ -1,138 +0,0 @@ -# Microsoft.CustomerInsights/hubs/connectors/mappings template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/connectors/mappings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/connectors/mappings", - "apiVersion": "2017-01-01", - "properties": { - "connectorType": "string", - "entityType": "string", - "entityTypeName": "string", - "displayName": "string", - "description": "string", - "mappingProperties": { - "folderPath": "string", - "fileFilter": "string", - "hasHeader": "boolean", - "errorManagement": { - "errorManagementType": "string", - "errorLimit": "integer" - }, - "format": { - "formatType": "TextFormat", - "columnDelimiter": "string", - "acceptLanguage": "string", - "quoteCharacter": "string", - "quoteEscapeCharacter": "string", - "arraySeparator": "string" - }, - "availability": { - "frequency": "string", - "interval": "integer" - }, - "structure": [ - { - "propertyName": "string", - "columnName": "string", - "customFormatSpecifier": "string", - "isEncrypted": "boolean" - } - ], - "completeOperation": { - "completionOperationType": "string", - "destinationFolder": "string" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/connectors/mappings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/connectors/mappings | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [ConnectorMapping object](#ConnectorMapping) | - - - -### ConnectorMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| connectorType | enum | No | Type of connector. - None, CRM, AzureBlob, Salesforce, ExchangeOnline, Outbound | -| entityType | enum | Yes | Defines which entity type the file should map to. - None, Profile, Interaction, Relationship | -| entityTypeName | string | Yes | The mapping entity name. | -| displayName | string | No | Display name for the connector mapping. | -| description | string | No | The description of the connector mapping. | -| mappingProperties | object | Yes | The properties of the mapping. - [ConnectorMappingProperties object](#ConnectorMappingProperties) | - - - -### ConnectorMappingProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| folderPath | string | No | The folder path for the mapping. | -| fileFilter | string | No | The file filter for the mapping. | -| hasHeader | boolean | No | If the file contains a header or not. | -| errorManagement | object | Yes | The error management setting for the mapping. - [ConnectorMappingErrorManagement object](#ConnectorMappingErrorManagement) | -| format | object | Yes | The format of mapping property. - [ConnectorMappingFormat object](#ConnectorMappingFormat) | -| availability | object | Yes | The availability of mapping property. - [ConnectorMappingAvailability object](#ConnectorMappingAvailability) | -| structure | array | Yes | Ingestion mapping information at property level. - [ConnectorMappingStructure object](#ConnectorMappingStructure) | -| completeOperation | object | Yes | The operation after import is done. - [ConnectorMappingCompleteOperation object](#ConnectorMappingCompleteOperation) | - - - -### ConnectorMappingErrorManagement object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| errorManagementType | enum | Yes | The type of error management to use for the mapping. - RejectAndContinue, StopImport, RejectUntilLimit | -| errorLimit | integer | No | The error limit allowed while importing data. | - - - -### ConnectorMappingFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| formatType | enum | Yes | The type mapping format. - TextFormat | -| columnDelimiter | string | No | The character that signifies a break between columns. | -| acceptLanguage | string | No | The oData language. | -| quoteCharacter | string | No | Quote character, used to indicate enquoted fields. | -| quoteEscapeCharacter | string | No | Escape character for quotes, can be the same as the quoteCharacter. | -| arraySeparator | string | No | Character separating array elements. | - - - -### ConnectorMappingAvailability object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frequency | enum | No | The frequency to update. - Minute, Hour, Day, Week, Month | -| interval | integer | Yes | The interval of the given frequency to use. | - - - -### ConnectorMappingStructure object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| propertyName | string | Yes | The property name of the mapping entity. | -| columnName | string | Yes | The column name of the import file. | -| customFormatSpecifier | string | No | Custom format specifier for input parsing. | -| isEncrypted | boolean | No | Indicates if the column is encrypted. | - - - -### ConnectorMappingCompleteOperation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| completionOperationType | enum | No | The type of completion operation. - DoNothing, DeleteFile, MoveFile | -| destinationFolder | string | No | The destination folder where files will be moved to once the import is done. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/interactions.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/interactions.md deleted file mode 100644 index fe248fb..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/interactions.md +++ /dev/null @@ -1,160 +0,0 @@ -# Microsoft.CustomerInsights/hubs/interactions template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/interactions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/interactions", - "apiVersion": "2017-01-01", - "properties": { - "attributes": {}, - "description": {}, - "displayName": {}, - "localizedAttributes": {}, - "smallImage": "string", - "mediumImage": "string", - "largeImage": "string", - "apiEntitySetName": "string", - "entityType": "string", - "fields": [ - { - "arrayValueSeparator": "string", - "enumValidValues": [ - { - "value": "integer", - "localizedValueNames": {} - } - ], - "fieldName": "string", - "fieldType": "string", - "isArray": "boolean", - "isEnum": "boolean", - "isFlagEnum": "boolean", - "isImage": "boolean", - "isLocalizedString": "boolean", - "isName": "boolean", - "isRequired": "boolean", - "propertyId": "string", - "schemaItemPropLink": "string", - "maxLength": "integer", - "isAvailableInGraph": "boolean" - } - ], - "instancesCount": "integer", - "schemaItemTypeLink": "string", - "timestampFieldName": "string", - "typeName": "string", - "idPropertyNames": [ - "string" - ], - "participantProfiles": [ - { - "profileTypeName": "string", - "participantPropertyReferences": [ - { - "interactionPropertyName": "string", - "profilePropertyName": "string" - } - ], - "participantName": "string", - "displayName": {}, - "description": {}, - "role": "string" - } - ], - "primaryParticipantProfilePropertyName": "string", - "defaultDataSource": {}, - "isActivity": "boolean" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/interactions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/interactions | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [InteractionTypeDefinition object](#InteractionTypeDefinition) | - - - -### InteractionTypeDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| attributes | object | No | The attributes for the Type. | -| description | object | No | Localized descriptions for the property. | -| displayName | object | No | Localized display names for the property. | -| localizedAttributes | object | No | Any custom localized attributes for the Type. | -| smallImage | string | No | Small Image associated with the Property or EntityType. | -| mediumImage | string | No | Medium Image associated with the Property or EntityType. | -| largeImage | string | No | Large Image associated with the Property or EntityType. | -| apiEntitySetName | string | No | The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object. | -| entityType | enum | No | Type of entity. - None, Profile, Interaction, Relationship | -| fields | array | No | The properties of the Profile. - [PropertyDefinition object](#PropertyDefinition) | -| instancesCount | integer | No | The instance count. | -| schemaItemTypeLink | string | No | The schema org link. This helps ACI identify and suggest semantic models. | -| timestampFieldName | string | No | The timestamp property name. Represents the time when the interaction or profile update happened. | -| typeName | string | No | The name of the entity. | -| idPropertyNames | array | No | The id property names. Properties which uniquely identify an interaction instance. - string | -| participantProfiles | array | No | Profiles that participated in the interaction. - [Participant object](#Participant) | -| primaryParticipantProfilePropertyName | string | No | 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. | -| defaultDataSource | object | No | Default data source is specifically used in cases where data source is not specified in an instance. - [DataSource object](#DataSource) | -| isActivity | boolean | No | 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. | - - - -### PropertyDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| arrayValueSeparator | string | No | Array value separator for properties with isArray set. | -| enumValidValues | array | No | Describes valid values for an enum property. - [ProfileEnumValidValuesFormat object](#ProfileEnumValidValuesFormat) | -| fieldName | string | Yes | Name of the property. | -| fieldType | string | Yes | Type of the property. | -| isArray | boolean | No | Indicates if the property is actually an array of the fieldType above on the data api. | -| isEnum | boolean | No | Indicates if the property is an enum. | -| isFlagEnum | boolean | No | Indicates if the property is an flag enum. | -| isImage | boolean | No | Whether the property is an Image. | -| isLocalizedString | boolean | No | Whether the property is a localized string. | -| isName | boolean | No | Whether the property is a name or a part of name. | -| isRequired | boolean | No | Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field. | -| propertyId | string | No | The ID associated with the property. | -| schemaItemPropLink | string | No | URL encoded schema.org item prop link for the property. | -| maxLength | integer | No | Max length of string. Used only if type is string. | -| isAvailableInGraph | boolean | No | Whether property is available in graph or not. | - - - -### Participant object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| profileTypeName | string | Yes | Profile type name. | -| participantPropertyReferences | array | Yes | The property references. - [ParticipantPropertyReference object](#ParticipantPropertyReference) | -| participantName | string | Yes | Participant name. | -| displayName | object | No | Localized display name. | -| description | object | No | Localized descriptions. | -| role | string | No | The role that the participant is playing in the interaction. | - - - -### ProfileEnumValidValuesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | integer | No | The integer value of the enum member. | -| localizedValueNames | object | No | Localized names of the enum member. | - - - -### ParticipantPropertyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| interactionPropertyName | string | Yes | The interaction property that maps to the profile property. | -| profilePropertyName | string | Yes | The profile property that maps to the interaction property. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/kpi.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/kpi.md deleted file mode 100644 index 59b4216..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/kpi.md +++ /dev/null @@ -1,103 +0,0 @@ -# Microsoft.CustomerInsights/hubs/kpi template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/kpi resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/kpi", - "apiVersion": "2017-01-01", - "properties": { - "entityType": "string", - "entityTypeName": "string", - "displayName": {}, - "description": {}, - "calculationWindow": "string", - "calculationWindowFieldName": "string", - "function": "string", - "expression": "string", - "unit": "string", - "filter": "string", - "groupBy": [ - "string" - ], - "thresHolds": { - "lowerLimit": "number", - "upperLimit": "number", - "increasingKpi": "boolean" - }, - "aliases": [ - { - "aliasName": "string", - "expression": "string" - } - ], - "extracts": [ - { - "extractName": "string", - "expression": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/kpi object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/kpi | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [KpiDefinition object](#KpiDefinition) | - - - -### KpiDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| entityType | enum | Yes | The mapping entity type. - None, Profile, Interaction, Relationship | -| entityTypeName | string | Yes | The mapping entity name. | -| displayName | object | No | Localized display name for the KPI. | -| description | object | No | Localized description for the KPI. | -| calculationWindow | enum | Yes | The calculation window. - Lifetime, Hour, Day, Week, Month | -| calculationWindowFieldName | string | No | Name of calculation window field. | -| function | enum | Yes | The computation function for the KPI. - Sum, Avg, Min, Max, Last, Count, None, CountDistinct | -| expression | string | Yes | The computation expression for the KPI. | -| unit | string | No | The unit of measurement for the KPI. | -| filter | string | No | The filter expression for the KPI. | -| groupBy | array | No | the group by properties for the KPI. - string | -| thresHolds | object | No | The KPI thresholds. - [KpiThresholds object](#KpiThresholds) | -| aliases | array | No | The aliases. - [KpiAlias object](#KpiAlias) | -| extracts | array | No | The KPI extracts. - [KpiExtract object](#KpiExtract) | - - - -### KpiThresholds object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lowerLimit | number | Yes | The lower threshold limit. | -| upperLimit | number | Yes | The upper threshold limit. | -| increasingKpi | boolean | Yes | Whether or not the KPI is an increasing KPI. | - - - -### KpiAlias object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| aliasName | string | Yes | KPI alias name. | -| expression | string | Yes | The expression. | - - - -### KpiExtract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| extractName | string | Yes | KPI extract name. | -| expression | string | Yes | The expression. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/links.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/links.md deleted file mode 100644 index 289f985..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/links.md +++ /dev/null @@ -1,80 +0,0 @@ -# Microsoft.CustomerInsights/hubs/links template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/links resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/links", - "apiVersion": "2017-01-01", - "properties": { - "sourceInteractionType": "string", - "targetProfileType": "string", - "displayName": {}, - "description": {}, - "mappings": [ - { - "interactionTypePropertyName": "string", - "profileTypePropertyName": "string", - "isProfileTypeId": "boolean", - "linkType": "string" - } - ], - "participantPropertyReferences": [ - { - "interactionPropertyName": "string", - "profilePropertyName": "string" - } - ], - "referenceOnly": "boolean", - "operationType": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/links object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/links | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [LinkDefinition object](#LinkDefinition) | - - - -### LinkDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceInteractionType | string | Yes | Name of the source Interaction Type. | -| targetProfileType | string | Yes | Name of the target Profile Type. | -| displayName | object | No | Localized display name for the Link. | -| description | object | No | Localized descriptions for the Link. | -| mappings | array | No | The set of properties mappings between the source and target Types. - [TypePropertiesMapping object](#TypePropertiesMapping) | -| participantPropertyReferences | array | Yes | The properties that represent the participating profile. - [ParticipantPropertyReference object](#ParticipantPropertyReference) | -| referenceOnly | boolean | No | Indicating whether the link is reference only link. This flag is ingored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles. | -| operationType | enum | No | Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only. - Upsert or Delete | - - - -### TypePropertiesMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| interactionTypePropertyName | string | Yes | Property name on the source Interaction Type. | -| profileTypePropertyName | string | Yes | Property name on the target Profile Type. | -| isProfileTypeId | boolean | No | Flag to indicate whether the Profile Type property is an id on the Profile Type. | -| linkType | enum | No | Link type. - UpdateAlways or CopyIfNull | - - - -### ParticipantPropertyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| interactionPropertyName | string | Yes | The interaction property that maps to the profile property. | -| profilePropertyName | string | Yes | The profile property that maps to the interaction property. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/profiles.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/profiles.md deleted file mode 100644 index 9f3f99d..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/profiles.md +++ /dev/null @@ -1,135 +0,0 @@ -# Microsoft.CustomerInsights/hubs/profiles template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/profiles resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/profiles", - "apiVersion": "2017-01-01", - "properties": { - "attributes": {}, - "description": {}, - "displayName": {}, - "localizedAttributes": {}, - "smallImage": "string", - "mediumImage": "string", - "largeImage": "string", - "apiEntitySetName": "string", - "entityType": "string", - "fields": [ - { - "arrayValueSeparator": "string", - "enumValidValues": [ - { - "value": "integer", - "localizedValueNames": {} - } - ], - "fieldName": "string", - "fieldType": "string", - "isArray": "boolean", - "isEnum": "boolean", - "isFlagEnum": "boolean", - "isImage": "boolean", - "isLocalizedString": "boolean", - "isName": "boolean", - "isRequired": "boolean", - "propertyId": "string", - "schemaItemPropLink": "string", - "maxLength": "integer", - "isAvailableInGraph": "boolean" - } - ], - "instancesCount": "integer", - "schemaItemTypeLink": "string", - "timestampFieldName": "string", - "typeName": "string", - "strongIds": [ - { - "keyPropertyNames": [ - "string" - ], - "strongIdName": "string", - "displayName": {}, - "description": {} - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/profiles object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/profiles | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [ProfileTypeDefinition object](#ProfileTypeDefinition) | - - - -### ProfileTypeDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| attributes | object | No | The attributes for the Type. | -| description | object | No | Localized descriptions for the property. | -| displayName | object | No | Localized display names for the property. | -| localizedAttributes | object | No | Any custom localized attributes for the Type. | -| smallImage | string | No | Small Image associated with the Property or EntityType. | -| mediumImage | string | No | Medium Image associated with the Property or EntityType. | -| largeImage | string | No | Large Image associated with the Property or EntityType. | -| apiEntitySetName | string | No | The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object. | -| entityType | enum | No | Type of entity. - None, Profile, Interaction, Relationship | -| fields | array | No | The properties of the Profile. - [PropertyDefinition object](#PropertyDefinition) | -| instancesCount | integer | No | The instance count. | -| schemaItemTypeLink | string | No | The schema org link. This helps ACI identify and suggest semantic models. | -| timestampFieldName | string | No | The timestamp property name. Represents the time when the interaction or profile update happened. | -| typeName | string | No | The name of the entity. | -| strongIds | array | No | The strong IDs. - [StrongId object](#StrongId) | - - - -### PropertyDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| arrayValueSeparator | string | No | Array value separator for properties with isArray set. | -| enumValidValues | array | No | Describes valid values for an enum property. - [ProfileEnumValidValuesFormat object](#ProfileEnumValidValuesFormat) | -| fieldName | string | Yes | Name of the property. | -| fieldType | string | Yes | Type of the property. | -| isArray | boolean | No | Indicates if the property is actually an array of the fieldType above on the data api. | -| isEnum | boolean | No | Indicates if the property is an enum. | -| isFlagEnum | boolean | No | Indicates if the property is an flag enum. | -| isImage | boolean | No | Whether the property is an Image. | -| isLocalizedString | boolean | No | Whether the property is a localized string. | -| isName | boolean | No | Whether the property is a name or a part of name. | -| isRequired | boolean | No | Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field. | -| propertyId | string | No | The ID associated with the property. | -| schemaItemPropLink | string | No | URL encoded schema.org item prop link for the property. | -| maxLength | integer | No | Max length of string. Used only if type is string. | -| isAvailableInGraph | boolean | No | Whether property is available in graph or not. | - - - -### StrongId object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyPropertyNames | array | Yes | The properties which make up the unique ID. - string | -| strongIdName | string | Yes | The Name identifying the strong ID. | -| displayName | object | No | Localized display name. | -| description | object | No | Localized descriptions. | - - - -### ProfileEnumValidValuesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | integer | No | The integer value of the enum member. | -| localizedValueNames | object | No | Localized names of the enum member. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/relationshipLinks.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/relationshipLinks.md deleted file mode 100644 index 6deda7d..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/relationshipLinks.md +++ /dev/null @@ -1,81 +0,0 @@ -# Microsoft.CustomerInsights/hubs/relationshipLinks template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/relationshipLinks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/relationshipLinks", - "apiVersion": "2017-01-01", - "properties": { - "displayName": {}, - "description": {}, - "interactionType": "string", - "mappings": [ - { - "interactionFieldName": "string", - "linkType": "string", - "relationshipFieldName": "string" - } - ], - "profilePropertyReferences": [ - { - "interactionPropertyName": "string", - "profilePropertyName": "string" - } - ], - "relatedProfilePropertyReferences": [ - { - "interactionPropertyName": "string", - "profilePropertyName": "string" - } - ], - "relationshipName": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/relationshipLinks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/relationshipLinks | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [RelationshipLinkDefinition object](#RelationshipLinkDefinition) | - - - -### RelationshipLinkDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| displayName | object | No | Localized display name for the Relationship Link. | -| description | object | No | Localized descriptions for the Relationship Link. | -| interactionType | string | Yes | The InteractionType associated with the Relationship Link. | -| mappings | array | No | The mappings between Interaction and Relationship fields. - [RelationshipLinkFieldMapping object](#RelationshipLinkFieldMapping) | -| profilePropertyReferences | array | Yes | The property references for the Profile of the Relationship. - [ParticipantPropertyReference object](#ParticipantPropertyReference) | -| relatedProfilePropertyReferences | array | Yes | The property references for the Related Profile of the Relationship. - [ParticipantPropertyReference object](#ParticipantPropertyReference) | -| relationshipName | string | Yes | The Relationship associated with the Link. | - - - -### RelationshipLinkFieldMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| interactionFieldName | string | Yes | The field name on the Interaction Type. | -| linkType | enum | No | Link type. - UpdateAlways or CopyIfNull | -| relationshipFieldName | string | Yes | The field name on the Relationship metadata. | - - - -### ParticipantPropertyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| interactionPropertyName | string | Yes | The interaction property that maps to the profile property. | -| profilePropertyName | string | Yes | The profile property that maps to the interaction property. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/relationships.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/relationships.md deleted file mode 100644 index 4f66443..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/relationships.md +++ /dev/null @@ -1,126 +0,0 @@ -# Microsoft.CustomerInsights/hubs/relationships template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/relationships resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/relationships", - "apiVersion": "2017-01-01", - "properties": { - "cardinality": "string", - "displayName": {}, - "description": {}, - "expiryDateTimeUtc": "string", - "fields": [ - { - "arrayValueSeparator": "string", - "enumValidValues": [ - { - "value": "integer", - "localizedValueNames": {} - } - ], - "fieldName": "string", - "fieldType": "string", - "isArray": "boolean", - "isEnum": "boolean", - "isFlagEnum": "boolean", - "isImage": "boolean", - "isLocalizedString": "boolean", - "isName": "boolean", - "isRequired": "boolean", - "propertyId": "string", - "schemaItemPropLink": "string", - "maxLength": "integer", - "isAvailableInGraph": "boolean" - } - ], - "lookupMappings": [ - { - "fieldMappings": [ - { - "profileFieldName": "string", - "relatedProfileKeyProperty": "string" - } - ] - } - ], - "profileType": "string", - "relatedProfileType": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/relationships object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/relationships | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [RelationshipDefinition object](#RelationshipDefinition) | - - - -### RelationshipDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| cardinality | enum | No | The Relationship Cardinality. - OneToOne, OneToMany, ManyToMany | -| displayName | object | No | Localized display name for the Relationship. | -| description | object | No | Localized descriptions for the Relationship. | -| expiryDateTimeUtc | string | No | The expiry date time in UTC. | -| fields | array | No | The properties of the Relationship. - [PropertyDefinition object](#PropertyDefinition) | -| lookupMappings | array | No | Optional property to be used to map fields in profile to their strong ids in related profile. - [RelationshipTypeMapping object](#RelationshipTypeMapping) | -| profileType | string | Yes | Profile type. | -| relatedProfileType | string | Yes | Related profile being referenced. | - - - -### PropertyDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| arrayValueSeparator | string | No | Array value separator for properties with isArray set. | -| enumValidValues | array | No | Describes valid values for an enum property. - [ProfileEnumValidValuesFormat object](#ProfileEnumValidValuesFormat) | -| fieldName | string | Yes | Name of the property. | -| fieldType | string | Yes | Type of the property. | -| isArray | boolean | No | Indicates if the property is actually an array of the fieldType above on the data api. | -| isEnum | boolean | No | Indicates if the property is an enum. | -| isFlagEnum | boolean | No | Indicates if the property is an flag enum. | -| isImage | boolean | No | Whether the property is an Image. | -| isLocalizedString | boolean | No | Whether the property is a localized string. | -| isName | boolean | No | Whether the property is a name or a part of name. | -| isRequired | boolean | No | Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field. | -| propertyId | string | No | The ID associated with the property. | -| schemaItemPropLink | string | No | URL encoded schema.org item prop link for the property. | -| maxLength | integer | No | Max length of string. Used only if type is string. | -| isAvailableInGraph | boolean | No | Whether property is available in graph or not. | - - - -### RelationshipTypeMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fieldMappings | array | Yes | Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. - [RelationshipTypeFieldMapping object](#RelationshipTypeFieldMapping) | - - - -### ProfileEnumValidValuesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | integer | No | The integer value of the enum member. | -| localizedValueNames | object | No | Localized names of the enum member. | - - - -### RelationshipTypeFieldMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| profileFieldName | string | Yes | Specifies the fieldName in profile. | -| relatedProfileKeyProperty | string | Yes | Specifies the KeyProperty (from StrongId) of the related profile. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/roleAssignments.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/roleAssignments.md deleted file mode 100644 index be9df7b..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/roleAssignments.md +++ /dev/null @@ -1,182 +0,0 @@ -# Microsoft.CustomerInsights/hubs/roleAssignments template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/roleAssignments resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/roleAssignments", - "apiVersion": "2017-01-01", - "properties": { - "displayName": {}, - "description": {}, - "role": "string", - "principals": [ - { - "principalId": "string", - "principalType": "string", - "principalMetadata": {} - } - ], - "profiles": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "interactions": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "links": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "kpis": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "sasPolicies": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "connectors": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "views": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "relationshipLinks": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "relationships": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "widgetTypes": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "roleAssignments": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "conflationPolicies": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "segments": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/roleAssignments object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/roleAssignments | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [RoleAssignment object](#RoleAssignment) | - - - -### RoleAssignment object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| displayName | object | No | Localized display names for the metadata. | -| description | object | No | Localized description for the metadata. | -| role | enum | Yes | Type of roles. - Admin, Reader, ManageAdmin, ManageReader, DataAdmin, DataReader | -| principals | array | Yes | The principals being assigned to. - [AssignmentPrincipal object](#AssignmentPrincipal) | -| profiles | object | No | Profiles set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| interactions | object | No | Interactions set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| links | object | No | Links set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| kpis | object | No | Kpis set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| sasPolicies | object | No | Sas Policies set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| connectors | object | No | Connectors set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| views | object | No | Views set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| relationshipLinks | object | No | The Role assignments set for the relationship links. - [ResourceSetDescription object](#ResourceSetDescription) | -| relationships | object | No | The Role assignments set for the relationships. - [ResourceSetDescription object](#ResourceSetDescription) | -| widgetTypes | object | No | Widget types set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| roleAssignments | object | No | The Role assignments set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| conflationPolicies | object | No | Widget types set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| segments | object | No | The Role assignments set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | - - - -### AssignmentPrincipal object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| principalId | string | Yes | The principal id being assigned to. | -| principalType | string | Yes | The Type of the principal ID. | -| principalMetadata | object | No | Other metadata for the principal. | - - - -### ResourceSetDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| elements | array | No | The elements included in the set. - string | -| exceptions | array | No | The elements that are not included in the set, in case elements contains '*' indicating 'all'. - string | - diff --git a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/views.md b/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/views.md deleted file mode 100644 index bcc2626..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-01-01/hubs/views.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.CustomerInsights/hubs/views template reference -API Version: 2017-01-01 -## Template format - -To create a Microsoft.CustomerInsights/hubs/views resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/views", - "apiVersion": "2017-01-01", - "properties": { - "userId": "string", - "displayName": {}, - "definition": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/views object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/views | -| apiVersion | enum | Yes | 2017-01-01 | -| properties | object | Yes | [View object](#View) | - - - -### View object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| userId | string | No | the user ID. | -| displayName | object | No | Localized display name for the view. | -| definition | string | Yes | View definition. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/Microsoft.CustomerInsights.json b/test/Resource/Expected/CustomerInsights/2017-04-26/Microsoft.CustomerInsights.json deleted file mode 100644 index 1046df3..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/Microsoft.CustomerInsights.json +++ /dev/null @@ -1,3407 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-04-26/Microsoft.CustomerInsights.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.CustomerInsights", - "description": "Microsoft CustomerInsights Resource Types", - "resourceDefinitions": { - "hubs": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/HubPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/hubs_profiles_childResource" - }, - { - "$ref": "#/definitions/hubs_interactions_childResource" - }, - { - "$ref": "#/definitions/hubs_relationships_childResource" - }, - { - "$ref": "#/definitions/hubs_relationshipLinks_childResource" - }, - { - "$ref": "#/definitions/hubs_authorizationPolicies_childResource" - }, - { - "$ref": "#/definitions/hubs_connectors_childResource" - }, - { - "$ref": "#/definitions/hubs_kpi_childResource" - }, - { - "$ref": "#/definitions/hubs_views_childResource" - }, - { - "$ref": "#/definitions/hubs_links_childResource" - }, - { - "$ref": "#/definitions/hubs_roleAssignments_childResource" - }, - { - "$ref": "#/definitions/hubs_predictions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs" - }, - "hubs_authorizationPolicies": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/authorizationPolicies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/authorizationPolicies" - }, - "hubs_connectors": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/connectors" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/Connector" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/hubs_connectors_mappings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/connectors" - }, - "hubs_connectors_mappings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/connectors/mappings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMapping" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/connectors/mappings" - }, - "hubs_interactions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/interactions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InteractionTypeDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/interactions" - }, - "hubs_kpi": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/kpi" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/KpiDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/kpi" - }, - "hubs_links": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/links" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LinkDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/links" - }, - "hubs_predictions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/predictions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/Prediction" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/predictions" - }, - "hubs_profiles": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/profiles" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProfileTypeDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/profiles" - }, - "hubs_relationshipLinks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/relationshipLinks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelationshipLinkDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/relationshipLinks" - }, - "hubs_relationships": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/relationships" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelationshipDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/relationships" - }, - "hubs_roleAssignments": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/roleAssignments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoleAssignment" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/roleAssignments" - }, - "hubs_views": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CustomerInsights/hubs/views" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/View" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/views" - } - }, - "definitions": { - "AssignmentPrincipal": { - "type": "object", - "properties": { - "principalId": { - "type": "string", - "description": "The principal id being assigned to." - }, - "principalType": { - "type": "string", - "description": "The Type of the principal ID." - }, - "principalMetadata": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Other metadata for the principal." - } - }, - "required": [ - "principalId", - "principalType" - ], - "description": "The AssignmentPrincipal" - }, - "AuthorizationPolicy": { - "type": "object", - "properties": { - "permissions": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Read", - "Write", - "Manage" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The permissions associated with the policy." - }, - "primaryKey": { - "type": "string", - "description": "Primary key assiciated with the policy." - }, - "secondaryKey": { - "type": "string", - "description": "Secondary key assiciated with the policy." - } - }, - "required": [ - "permissions" - ], - "description": "The authorization policy." - }, - "Connector": { - "type": "object", - "properties": { - "connectorName": { - "type": "string", - "description": "Name of the connector." - }, - "connectorType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "CRM", - "AzureBlob", - "Salesforce", - "ExchangeOnline", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of connector." - }, - "displayName": { - "type": "string", - "description": "Display name of the connector." - }, - "description": { - "type": "string", - "description": "Description of the connector." - }, - "connectorProperties": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": {} - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The connector properties." - }, - "isInternal": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If this is an internal connector." - } - }, - "required": [ - "connectorType", - "connectorProperties" - ], - "description": "Properties of connector." - }, - "ConnectorMapping": { - "type": "object", - "properties": { - "connectorType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "CRM", - "AzureBlob", - "Salesforce", - "ExchangeOnline", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of connector." - }, - "entityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Defines which entity type the file should map to." - }, - "entityTypeName": { - "type": "string", - "description": "The mapping entity name." - }, - "displayName": { - "type": "string", - "description": "Display name for the connector mapping." - }, - "description": { - "type": "string", - "description": "The description of the connector mapping." - }, - "mappingProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the mapping." - } - }, - "required": [ - "entityType", - "entityTypeName", - "mappingProperties" - ], - "description": "The connector mapping definition." - }, - "ConnectorMappingAvailability": { - "type": "object", - "properties": { - "frequency": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The frequency to update." - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interval of the given frequency to use." - } - }, - "required": [ - "interval" - ], - "description": "Connector mapping property availability." - }, - "ConnectorMappingCompleteOperation": { - "type": "object", - "properties": { - "completionOperationType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "DoNothing", - "DeleteFile", - "MoveFile" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of completion operation." - }, - "destinationFolder": { - "type": "string", - "description": "The destination folder where files will be moved to once the import is done." - } - }, - "description": "The complete operation." - }, - "ConnectorMappingErrorManagement": { - "type": "object", - "properties": { - "errorManagementType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "RejectAndContinue", - "StopImport", - "RejectUntilLimit" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of error management to use for the mapping." - }, - "errorLimit": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The error limit allowed while importing data." - } - }, - "required": [ - "errorManagementType" - ], - "description": "The error mangement." - }, - "ConnectorMappingFormat": { - "type": "object", - "properties": { - "formatType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TextFormat" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type mapping format." - }, - "columnDelimiter": { - "type": "string", - "description": "The character that signifies a break between columns." - }, - "acceptLanguage": { - "type": "string", - "description": "The oData language." - }, - "quoteCharacter": { - "type": "string", - "description": "Quote character, used to indicate enquoted fields." - }, - "quoteEscapeCharacter": { - "type": "string", - "description": "Escape character for quotes, can be the same as the quoteCharacter." - }, - "arraySeparator": { - "type": "string", - "description": "Character separating array elements." - } - }, - "required": [ - "formatType" - ], - "description": "Connector mapping property format." - }, - "ConnectorMappingProperties": { - "type": "object", - "properties": { - "folderPath": { - "type": "string", - "description": "The folder path for the mapping." - }, - "fileFilter": { - "type": "string", - "description": "The file filter for the mapping." - }, - "hasHeader": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the file contains a header or not." - }, - "errorManagement": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingErrorManagement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The error management setting for the mapping." - }, - "format": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The format of mapping property." - }, - "availability": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingAvailability" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The availability of mapping property." - }, - "structure": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ConnectorMappingStructure" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ingestion mapping information at property level." - }, - "completeOperation": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMappingCompleteOperation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The operation after import is done." - } - }, - "required": [ - "errorManagement", - "format", - "availability", - "structure", - "completeOperation" - ], - "description": "The connector mapping properties." - }, - "ConnectorMappingStructure": { - "type": "object", - "properties": { - "propertyName": { - "type": "string", - "description": "The property name of the mapping entity." - }, - "columnName": { - "type": "string", - "description": "The column name of the import file." - }, - "customFormatSpecifier": { - "type": "string", - "description": "Custom format specifier for input parsing." - }, - "isEncrypted": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if the column is encrypted." - } - }, - "required": [ - "propertyName", - "columnName" - ], - "description": "Connector mapping property structure." - }, - "DataSource": { - "type": "object", - "properties": {}, - "description": "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." - }, - "HubBillingInfoFormat": { - "type": "object", - "properties": { - "skuName": { - "type": "string", - "description": "The sku name." - }, - "minUnits": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 10 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions." - }, - "maxUnits": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 10 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions." - } - }, - "description": "Hub billing info." - }, - "HubPropertiesFormat": { - "type": "object", - "properties": { - "tenantFeatures": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "hubBillingInfo": { - "oneOf": [ - { - "$ref": "#/definitions/HubBillingInfoFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Billing settings of the hub." - } - }, - "description": "Properties of hub." - }, - "hubs_authorizationPolicies_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizationPolicies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/authorizationPolicies" - }, - "hubs_connectors_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "connectors" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/Connector" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/connectors" - }, - "hubs_connectors_mappings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "mappings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectorMapping" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/connectors/mappings" - }, - "hubs_interactions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "interactions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InteractionTypeDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/interactions" - }, - "hubs_kpi_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "kpi" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/KpiDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/kpi" - }, - "hubs_links_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "links" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LinkDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/links" - }, - "hubs_predictions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "predictions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/Prediction" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/predictions" - }, - "hubs_profiles_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "profiles" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProfileTypeDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/profiles" - }, - "hubs_relationshipLinks_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "relationshipLinks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelationshipLinkDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/relationshipLinks" - }, - "hubs_relationships_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "relationships" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelationshipDefinition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/relationships" - }, - "hubs_roleAssignments_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "roleAssignments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoleAssignment" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/roleAssignments" - }, - "hubs_views_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "views" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-26" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/View" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.CustomerInsights/hubs/views" - }, - "InteractionTypeDefinition": { - "type": "object", - "properties": { - "attributes": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The attributes for the Type." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the property." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display names for the property." - }, - "localizedAttributes": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Any custom localized attributes for the Type." - }, - "smallImage": { - "type": "string", - "description": "Small Image associated with the Property or EntityType." - }, - "mediumImage": { - "type": "string", - "description": "Medium Image associated with the Property or EntityType." - }, - "largeImage": { - "type": "string", - "description": "Large Image associated with the Property or EntityType." - }, - "apiEntitySetName": { - "type": "string", - "description": "The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object." - }, - "entityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of entity." - }, - "fields": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PropertyDefinition" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the Profile." - }, - "instancesCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The instance count." - }, - "schemaItemTypeLink": { - "type": "string", - "description": "The schema org link. This helps ACI identify and suggest semantic models." - }, - "timestampFieldName": { - "type": "string", - "description": "The timestamp property name. Represents the time when the interaction or profile update happened." - }, - "typeName": { - "type": "string", - "description": "The name of the entity." - }, - "idPropertyNames": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The id property names. Properties which uniquely identify an interaction instance." - }, - "participantProfiles": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Participant" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Profiles that participated in the interaction." - }, - "primaryParticipantProfilePropertyName": { - "type": "string", - "description": "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." - }, - "defaultDataSource": { - "oneOf": [ - { - "$ref": "#/definitions/DataSource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default data source is specifically used in cases where data source is not specified in an instance." - }, - "isActivity": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "description": "The Interaction Type Definition" - }, - "KpiAlias": { - "type": "object", - "properties": { - "aliasName": { - "type": "string", - "description": "KPI alias name." - }, - "expression": { - "type": "string", - "description": "The expression." - } - }, - "required": [ - "aliasName", - "expression" - ], - "description": "The KPI alias." - }, - "KpiDefinition": { - "type": "object", - "properties": { - "entityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The mapping entity type." - }, - "entityTypeName": { - "type": "string", - "description": "The mapping entity name." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the KPI." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized description for the KPI." - }, - "calculationWindow": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Lifetime", - "Hour", - "Day", - "Week", - "Month" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The calculation window." - }, - "calculationWindowFieldName": { - "type": "string", - "description": "Name of calculation window field." - }, - "function": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Sum", - "Avg", - "Min", - "Max", - "Last", - "Count", - "None", - "CountDistinct" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The computation function for the KPI." - }, - "expression": { - "type": "string", - "description": "The computation expression for the KPI." - }, - "unit": { - "type": "string", - "description": "The unit of measurement for the KPI." - }, - "filter": { - "type": "string", - "description": "The filter expression for the KPI." - }, - "groupBy": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the group by properties for the KPI." - }, - "thresHolds": { - "oneOf": [ - { - "$ref": "#/definitions/KpiThresholds" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The KPI thresholds." - }, - "aliases": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/KpiAlias" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The aliases." - }, - "extracts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/KpiExtract" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The KPI extracts." - } - }, - "required": [ - "entityType", - "entityTypeName", - "calculationWindow", - "function", - "expression" - ], - "description": "Defines the KPI Threshold limits." - }, - "KpiExtract": { - "type": "object", - "properties": { - "extractName": { - "type": "string", - "description": "KPI extract name." - }, - "expression": { - "type": "string", - "description": "The expression." - } - }, - "required": [ - "extractName", - "expression" - ], - "description": "The KPI extract." - }, - "KpiThresholds": { - "type": "object", - "properties": { - "lowerLimit": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The lower threshold limit." - }, - "upperLimit": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The upper threshold limit." - }, - "increasingKpi": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether or not the KPI is an increasing KPI." - } - }, - "required": [ - "lowerLimit", - "upperLimit", - "increasingKpi" - ], - "description": "Defines the KPI Threshold limits." - }, - "LinkDefinition": { - "type": "object", - "properties": { - "sourceEntityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of source entity." - }, - "targetEntityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of target entity." - }, - "sourceEntityTypeName": { - "type": "string", - "description": "Name of the source Entity Type." - }, - "targetEntityTypeName": { - "type": "string", - "description": "Name of the target Entity Type." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the Link." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the Link." - }, - "mappings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/TypePropertiesMapping" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The set of properties mappings between the source and target Types." - }, - "participantPropertyReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantPropertyReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties that represent the participating profile." - }, - "referenceOnly": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicating whether the link is reference only link. This flag is ingored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles." - }, - "operationType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Upsert", - "Delete" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only." - } - }, - "required": [ - "sourceEntityType", - "targetEntityType", - "sourceEntityTypeName", - "targetEntityTypeName", - "participantPropertyReferences" - ], - "description": "The definition of Link." - }, - "Participant": { - "type": "object", - "properties": { - "profileTypeName": { - "type": "string", - "description": "Profile type name." - }, - "participantPropertyReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantPropertyReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The property references." - }, - "participantName": { - "type": "string", - "description": "Participant name." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions." - }, - "role": { - "type": "string", - "description": "The role that the participant is playing in the interaction." - } - }, - "required": [ - "profileTypeName", - "participantPropertyReferences", - "participantName" - ], - "description": "Describes a profile type participating in an interaction." - }, - "ParticipantProfilePropertyReference": { - "type": "object", - "properties": { - "interactionPropertyName": { - "type": "string", - "description": "The source interaction property that maps to the target profile property." - }, - "profilePropertyName": { - "type": "string", - "description": "The target profile property that maps to the source interaction property." - } - }, - "required": [ - "interactionPropertyName", - "profilePropertyName" - ], - "description": "The participant profile property reference." - }, - "ParticipantPropertyReference": { - "type": "object", - "properties": { - "sourcePropertyName": { - "type": "string", - "description": "The source property that maps to the target property." - }, - "targetPropertyName": { - "type": "string", - "description": "The target property that maps to the source property." - } - }, - "required": [ - "sourcePropertyName", - "targetPropertyName" - ], - "description": "The participant property reference." - }, - "Prediction": { - "type": "object", - "properties": { - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Description of the prediction." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Display name of the prediction." - }, - "involvedInteractionTypes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Interaction types involved in the prediction." - }, - "involvedKpiTypes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "KPI types involved in the prediction." - }, - "involvedRelationships": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Relationships involved in the prediction." - }, - "negativeOutcomeExpression": { - "type": "string", - "description": "Negative outcome expression." - }, - "positiveOutcomeExpression": { - "type": "string", - "description": "Positive outcome expression." - }, - "primaryProfileType": { - "type": "string", - "description": "Primary profile type." - }, - "predictionName": { - "type": "string", - "description": "Name of the prediction." - }, - "scopeExpression": { - "type": "string", - "description": "Scope expression." - }, - "autoAnalyze": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether do auto analyze." - }, - "mappings": { - "oneOf": [ - { - "$ref": "#/definitions/PredictionMappings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Definition of the link mapping of prediction." - }, - "scoreLabel": { - "type": "string", - "description": "Score label." - }, - "grades": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PredictionGradesItem" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The prediction grades." - } - }, - "required": [ - "negativeOutcomeExpression", - "positiveOutcomeExpression", - "primaryProfileType", - "scopeExpression", - "autoAnalyze", - "mappings", - "scoreLabel" - ], - "description": "The prediction definition." - }, - "PredictionGradesItem": { - "type": "object", - "properties": { - "gradeName": { - "type": "string", - "description": "Name of the grade." - }, - "minScoreThreshold": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum score threshold." - }, - "maxScoreThreshold": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum score threshold." - } - }, - "description": "The definition of a prediction grade." - }, - "PredictionMappings": { - "type": "object", - "properties": { - "score": { - "type": "string", - "description": "The score of the link mapping." - }, - "grade": { - "type": "string", - "description": "The grade of the link mapping." - }, - "reason": { - "type": "string", - "description": "The reason of the link mapping." - } - }, - "required": [ - "score", - "grade", - "reason" - ], - "description": "Definition of the link mapping of prediction." - }, - "ProfileEnumValidValuesFormat": { - "type": "object", - "properties": { - "value": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integer value of the enum member." - }, - "localizedValueNames": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized names of the enum member." - } - }, - "description": "Valid enum values in case of an enum property." - }, - "ProfileTypeDefinition": { - "type": "object", - "properties": { - "attributes": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The attributes for the Type." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the property." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display names for the property." - }, - "localizedAttributes": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Any custom localized attributes for the Type." - }, - "smallImage": { - "type": "string", - "description": "Small Image associated with the Property or EntityType." - }, - "mediumImage": { - "type": "string", - "description": "Medium Image associated with the Property or EntityType." - }, - "largeImage": { - "type": "string", - "description": "Large Image associated with the Property or EntityType." - }, - "apiEntitySetName": { - "type": "string", - "description": "The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object." - }, - "entityType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Profile", - "Interaction", - "Relationship" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of entity." - }, - "fields": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PropertyDefinition" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the Profile." - }, - "instancesCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The instance count." - }, - "schemaItemTypeLink": { - "type": "string", - "description": "The schema org link. This helps ACI identify and suggest semantic models." - }, - "timestampFieldName": { - "type": "string", - "description": "The timestamp property name. Represents the time when the interaction or profile update happened." - }, - "typeName": { - "type": "string", - "description": "The name of the entity." - }, - "strongIds": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/StrongId" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The strong IDs." - } - }, - "description": "The profile type definition." - }, - "PropertyDefinition": { - "type": "object", - "properties": { - "arrayValueSeparator": { - "type": "string", - "description": "Array value separator for properties with isArray set." - }, - "enumValidValues": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ProfileEnumValidValuesFormat" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Describes valid values for an enum property." - }, - "fieldName": { - "type": "string", - "description": "Name of the property." - }, - "fieldType": { - "type": "string", - "description": "Type of the property." - }, - "isArray": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if the property is actually an array of the fieldType above on the data api." - }, - "isEnum": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if the property is an enum." - }, - "isFlagEnum": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if the property is an flag enum." - }, - "isImage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the property is an Image." - }, - "isLocalizedString": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the property is a localized string." - }, - "isName": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the property is a name or a part of name." - }, - "isRequired": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field." - }, - "propertyId": { - "type": "string", - "description": "The ID associated with the property." - }, - "schemaItemPropLink": { - "type": "string", - "description": "URL encoded schema.org item prop link for the property." - }, - "maxLength": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Max length of string. Used only if type is string." - }, - "isAvailableInGraph": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether property is available in graph or not." - } - }, - "required": [ - "fieldName", - "fieldType" - ], - "description": "Property definition." - }, - "RelationshipDefinition": { - "type": "object", - "properties": { - "cardinality": { - "oneOf": [ - { - "type": "string", - "enum": [ - "OneToOne", - "OneToMany", - "ManyToMany" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Relationship Cardinality." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the Relationship." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the Relationship." - }, - "expiryDateTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The expiry date time in UTC." - }, - "fields": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PropertyDefinition" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the Relationship." - }, - "lookupMappings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RelationshipTypeMapping" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Optional property to be used to map fields in profile to their strong ids in related profile." - }, - "profileType": { - "type": "string", - "description": "Profile type." - }, - "relatedProfileType": { - "type": "string", - "description": "Related profile being referenced." - } - }, - "required": [ - "profileType", - "relatedProfileType" - ], - "description": "The definition of Relationship." - }, - "RelationshipLinkDefinition": { - "type": "object", - "properties": { - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the Relationship Link." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions for the Relationship Link." - }, - "interactionType": { - "type": "string", - "description": "The InteractionType associated with the Relationship Link." - }, - "mappings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RelationshipLinkFieldMapping" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The mappings between Interaction and Relationship fields." - }, - "profilePropertyReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantProfilePropertyReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The property references for the Profile of the Relationship." - }, - "relatedProfilePropertyReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ParticipantProfilePropertyReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The property references for the Related Profile of the Relationship." - }, - "relationshipName": { - "type": "string", - "description": "The Relationship associated with the Link." - } - }, - "required": [ - "interactionType", - "profilePropertyReferences", - "relatedProfilePropertyReferences", - "relationshipName" - ], - "description": "The definition of relationship link." - }, - "RelationshipLinkFieldMapping": { - "type": "object", - "properties": { - "interactionFieldName": { - "type": "string", - "description": "The field name on the Interaction Type." - }, - "linkType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UpdateAlways", - "CopyIfNull" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Link type." - }, - "relationshipFieldName": { - "type": "string", - "description": "The field name on the Relationship metadata." - } - }, - "required": [ - "interactionFieldName", - "relationshipFieldName" - ], - "description": "The fields mapping for Relationships." - }, - "RelationshipTypeFieldMapping": { - "type": "object", - "properties": { - "profileFieldName": { - "type": "string", - "description": "Specifies the fieldName in profile." - }, - "relatedProfileKeyProperty": { - "type": "string", - "description": "Specifies the KeyProperty (from StrongId) of the related profile." - } - }, - "required": [ - "profileFieldName", - "relatedProfileKeyProperty" - ], - "description": "Map a field of profile to its corresponding StrongId in Related Profile." - }, - "RelationshipTypeMapping": { - "type": "object", - "properties": { - "fieldMappings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RelationshipTypeFieldMapping" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well." - } - }, - "required": [ - "fieldMappings" - ], - "description": "Maps fields in Profile to their corresponding StrongIds in Related Profile." - }, - "ResourceSetDescription": { - "type": "object", - "properties": { - "elements": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The elements included in the set." - }, - "exceptions": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The elements that are not included in the set, in case elements contains '*' indicating 'all'." - } - }, - "description": "The resource set description." - }, - "RoleAssignment": { - "type": "object", - "properties": { - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display names for the metadata." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized description for the metadata." - }, - "role": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Admin", - "Reader", - "ManageAdmin", - "ManageReader", - "DataAdmin", - "DataReader" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of roles." - }, - "principals": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AssignmentPrincipal" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The principals being assigned to." - }, - "profiles": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Profiles set for the assignment." - }, - "interactions": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Interactions set for the assignment." - }, - "links": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Links set for the assignment." - }, - "kpis": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Kpis set for the assignment." - }, - "sasPolicies": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sas Policies set for the assignment." - }, - "connectors": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connectors set for the assignment." - }, - "views": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Views set for the assignment." - }, - "relationshipLinks": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Role assignments set for the relationship links." - }, - "relationships": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Role assignments set for the relationships." - }, - "widgetTypes": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Widget types set for the assignment." - }, - "roleAssignments": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Role assignments set for the assignment." - }, - "conflationPolicies": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Widget types set for the assignment." - }, - "segments": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceSetDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Role assignments set for the assignment." - } - }, - "required": [ - "role", - "principals" - ], - "description": "The Role Assignment definition." - }, - "StrongId": { - "type": "object", - "properties": { - "keyPropertyNames": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties which make up the unique ID." - }, - "strongIdName": { - "type": "string", - "description": "The Name identifying the strong ID." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name." - }, - "description": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized descriptions." - } - }, - "required": [ - "keyPropertyNames", - "strongIdName" - ], - "description": "Property/Properties which represent a unique ID." - }, - "TypePropertiesMapping": { - "type": "object", - "properties": { - "sourcePropertyName": { - "type": "string", - "description": " Property name on the source Entity Type." - }, - "targetPropertyName": { - "type": "string", - "description": "Property name on the target Entity Type." - }, - "linkType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UpdateAlways", - "CopyIfNull" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Link type." - } - }, - "required": [ - "sourcePropertyName", - "targetPropertyName" - ], - "description": "Metadata for a Link's property mapping." - }, - "View": { - "type": "object", - "properties": { - "userId": { - "type": "string", - "description": "the user ID." - }, - "displayName": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Localized display name for the view." - }, - "definition": { - "type": "string", - "description": "View definition." - } - }, - "required": [ - "definition" - ], - "description": "The view in Customer 360 web application." - } - } -} diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs.md deleted file mode 100644 index 0bceeb0..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs.md +++ /dev/null @@ -1,57 +0,0 @@ -# Microsoft.CustomerInsights/hubs template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs", - "apiVersion": "2017-04-26", - "location": "string", - "tags": {}, - "properties": { - "tenantFeatures": "integer", - "hubBillingInfo": { - "skuName": "string", - "minUnits": "integer", - "maxUnits": "integer" - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs | -| apiVersion | enum | Yes | 2017-04-26 | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [HubPropertiesFormat object](#HubPropertiesFormat) | -| resources | array | No | [predictions](./hubs/predictions.md) [roleAssignments](./hubs/roleAssignments.md) [links](./hubs/links.md) [views](./hubs/views.md) [kpi](./hubs/kpi.md) [connectors](./hubs/connectors.md) [authorizationPolicies](./hubs/authorizationPolicies.md) [relationshipLinks](./hubs/relationshipLinks.md) [relationships](./hubs/relationships.md) [interactions](./hubs/interactions.md) [profiles](./hubs/profiles.md) | - - - -### HubPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| tenantFeatures | integer | No | 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. | -| hubBillingInfo | object | No | Billing settings of the hub. - [HubBillingInfoFormat object](#HubBillingInfoFormat) | - - - -### HubBillingInfoFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| skuName | string | No | The sku name. | -| minUnits | integer | No | The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. | -| maxUnits | integer | No | The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/authorizationPolicies.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/authorizationPolicies.md deleted file mode 100644 index a19bfa8..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/authorizationPolicies.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.CustomerInsights/hubs/authorizationPolicies template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/authorizationPolicies resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/authorizationPolicies", - "apiVersion": "2017-04-26", - "properties": { - "permissions": [ - "string" - ], - "primaryKey": "string", - "secondaryKey": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/authorizationPolicies object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/authorizationPolicies | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [AuthorizationPolicy object](#AuthorizationPolicy) | - - - -### AuthorizationPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| permissions | array | Yes | The permissions associated with the policy. - Read, Write, Manage | -| primaryKey | string | No | Primary key assiciated with the policy. | -| secondaryKey | string | No | Secondary key assiciated with the policy. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/connectors.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/connectors.md deleted file mode 100644 index a85f20a..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/connectors.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.CustomerInsights/hubs/connectors template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/connectors resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/connectors", - "apiVersion": "2017-04-26", - "properties": { - "connectorName": "string", - "connectorType": "string", - "displayName": "string", - "description": "string", - "connectorProperties": {}, - "isInternal": "boolean" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/connectors object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/connectors | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [Connector object](#Connector) | -| resources | array | No | [mappings](./connectors/mappings.md) | - - - -### Connector object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| connectorName | string | No | Name of the connector. | -| connectorType | enum | Yes | Type of connector. - None, CRM, AzureBlob, Salesforce, ExchangeOnline, Outbound | -| displayName | string | No | Display name of the connector. | -| description | string | No | Description of the connector. | -| connectorProperties | object | Yes | The connector properties. | -| isInternal | boolean | No | If this is an internal connector. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/connectors/mappings.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/connectors/mappings.md deleted file mode 100644 index cf89400..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/connectors/mappings.md +++ /dev/null @@ -1,138 +0,0 @@ -# Microsoft.CustomerInsights/hubs/connectors/mappings template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/connectors/mappings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/connectors/mappings", - "apiVersion": "2017-04-26", - "properties": { - "connectorType": "string", - "entityType": "string", - "entityTypeName": "string", - "displayName": "string", - "description": "string", - "mappingProperties": { - "folderPath": "string", - "fileFilter": "string", - "hasHeader": "boolean", - "errorManagement": { - "errorManagementType": "string", - "errorLimit": "integer" - }, - "format": { - "formatType": "TextFormat", - "columnDelimiter": "string", - "acceptLanguage": "string", - "quoteCharacter": "string", - "quoteEscapeCharacter": "string", - "arraySeparator": "string" - }, - "availability": { - "frequency": "string", - "interval": "integer" - }, - "structure": [ - { - "propertyName": "string", - "columnName": "string", - "customFormatSpecifier": "string", - "isEncrypted": "boolean" - } - ], - "completeOperation": { - "completionOperationType": "string", - "destinationFolder": "string" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/connectors/mappings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/connectors/mappings | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [ConnectorMapping object](#ConnectorMapping) | - - - -### ConnectorMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| connectorType | enum | No | Type of connector. - None, CRM, AzureBlob, Salesforce, ExchangeOnline, Outbound | -| entityType | enum | Yes | Defines which entity type the file should map to. - None, Profile, Interaction, Relationship | -| entityTypeName | string | Yes | The mapping entity name. | -| displayName | string | No | Display name for the connector mapping. | -| description | string | No | The description of the connector mapping. | -| mappingProperties | object | Yes | The properties of the mapping. - [ConnectorMappingProperties object](#ConnectorMappingProperties) | - - - -### ConnectorMappingProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| folderPath | string | No | The folder path for the mapping. | -| fileFilter | string | No | The file filter for the mapping. | -| hasHeader | boolean | No | If the file contains a header or not. | -| errorManagement | object | Yes | The error management setting for the mapping. - [ConnectorMappingErrorManagement object](#ConnectorMappingErrorManagement) | -| format | object | Yes | The format of mapping property. - [ConnectorMappingFormat object](#ConnectorMappingFormat) | -| availability | object | Yes | The availability of mapping property. - [ConnectorMappingAvailability object](#ConnectorMappingAvailability) | -| structure | array | Yes | Ingestion mapping information at property level. - [ConnectorMappingStructure object](#ConnectorMappingStructure) | -| completeOperation | object | Yes | The operation after import is done. - [ConnectorMappingCompleteOperation object](#ConnectorMappingCompleteOperation) | - - - -### ConnectorMappingErrorManagement object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| errorManagementType | enum | Yes | The type of error management to use for the mapping. - RejectAndContinue, StopImport, RejectUntilLimit | -| errorLimit | integer | No | The error limit allowed while importing data. | - - - -### ConnectorMappingFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| formatType | enum | Yes | The type mapping format. - TextFormat | -| columnDelimiter | string | No | The character that signifies a break between columns. | -| acceptLanguage | string | No | The oData language. | -| quoteCharacter | string | No | Quote character, used to indicate enquoted fields. | -| quoteEscapeCharacter | string | No | Escape character for quotes, can be the same as the quoteCharacter. | -| arraySeparator | string | No | Character separating array elements. | - - - -### ConnectorMappingAvailability object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frequency | enum | No | The frequency to update. - Minute, Hour, Day, Week, Month | -| interval | integer | Yes | The interval of the given frequency to use. | - - - -### ConnectorMappingStructure object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| propertyName | string | Yes | The property name of the mapping entity. | -| columnName | string | Yes | The column name of the import file. | -| customFormatSpecifier | string | No | Custom format specifier for input parsing. | -| isEncrypted | boolean | No | Indicates if the column is encrypted. | - - - -### ConnectorMappingCompleteOperation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| completionOperationType | enum | No | The type of completion operation. - DoNothing, DeleteFile, MoveFile | -| destinationFolder | string | No | The destination folder where files will be moved to once the import is done. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/interactions.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/interactions.md deleted file mode 100644 index ca830f2..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/interactions.md +++ /dev/null @@ -1,160 +0,0 @@ -# Microsoft.CustomerInsights/hubs/interactions template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/interactions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/interactions", - "apiVersion": "2017-04-26", - "properties": { - "attributes": {}, - "description": {}, - "displayName": {}, - "localizedAttributes": {}, - "smallImage": "string", - "mediumImage": "string", - "largeImage": "string", - "apiEntitySetName": "string", - "entityType": "string", - "fields": [ - { - "arrayValueSeparator": "string", - "enumValidValues": [ - { - "value": "integer", - "localizedValueNames": {} - } - ], - "fieldName": "string", - "fieldType": "string", - "isArray": "boolean", - "isEnum": "boolean", - "isFlagEnum": "boolean", - "isImage": "boolean", - "isLocalizedString": "boolean", - "isName": "boolean", - "isRequired": "boolean", - "propertyId": "string", - "schemaItemPropLink": "string", - "maxLength": "integer", - "isAvailableInGraph": "boolean" - } - ], - "instancesCount": "integer", - "schemaItemTypeLink": "string", - "timestampFieldName": "string", - "typeName": "string", - "idPropertyNames": [ - "string" - ], - "participantProfiles": [ - { - "profileTypeName": "string", - "participantPropertyReferences": [ - { - "sourcePropertyName": "string", - "targetPropertyName": "string" - } - ], - "participantName": "string", - "displayName": {}, - "description": {}, - "role": "string" - } - ], - "primaryParticipantProfilePropertyName": "string", - "defaultDataSource": {}, - "isActivity": "boolean" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/interactions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/interactions | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [InteractionTypeDefinition object](#InteractionTypeDefinition) | - - - -### InteractionTypeDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| attributes | object | No | The attributes for the Type. | -| description | object | No | Localized descriptions for the property. | -| displayName | object | No | Localized display names for the property. | -| localizedAttributes | object | No | Any custom localized attributes for the Type. | -| smallImage | string | No | Small Image associated with the Property or EntityType. | -| mediumImage | string | No | Medium Image associated with the Property or EntityType. | -| largeImage | string | No | Large Image associated with the Property or EntityType. | -| apiEntitySetName | string | No | The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object. | -| entityType | enum | No | Type of entity. - None, Profile, Interaction, Relationship | -| fields | array | No | The properties of the Profile. - [PropertyDefinition object](#PropertyDefinition) | -| instancesCount | integer | No | The instance count. | -| schemaItemTypeLink | string | No | The schema org link. This helps ACI identify and suggest semantic models. | -| timestampFieldName | string | No | The timestamp property name. Represents the time when the interaction or profile update happened. | -| typeName | string | No | The name of the entity. | -| idPropertyNames | array | No | The id property names. Properties which uniquely identify an interaction instance. - string | -| participantProfiles | array | No | Profiles that participated in the interaction. - [Participant object](#Participant) | -| primaryParticipantProfilePropertyName | string | No | 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. | -| defaultDataSource | object | No | Default data source is specifically used in cases where data source is not specified in an instance. - [DataSource object](#DataSource) | -| isActivity | boolean | No | 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. | - - - -### PropertyDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| arrayValueSeparator | string | No | Array value separator for properties with isArray set. | -| enumValidValues | array | No | Describes valid values for an enum property. - [ProfileEnumValidValuesFormat object](#ProfileEnumValidValuesFormat) | -| fieldName | string | Yes | Name of the property. | -| fieldType | string | Yes | Type of the property. | -| isArray | boolean | No | Indicates if the property is actually an array of the fieldType above on the data api. | -| isEnum | boolean | No | Indicates if the property is an enum. | -| isFlagEnum | boolean | No | Indicates if the property is an flag enum. | -| isImage | boolean | No | Whether the property is an Image. | -| isLocalizedString | boolean | No | Whether the property is a localized string. | -| isName | boolean | No | Whether the property is a name or a part of name. | -| isRequired | boolean | No | Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field. | -| propertyId | string | No | The ID associated with the property. | -| schemaItemPropLink | string | No | URL encoded schema.org item prop link for the property. | -| maxLength | integer | No | Max length of string. Used only if type is string. | -| isAvailableInGraph | boolean | No | Whether property is available in graph or not. | - - - -### Participant object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| profileTypeName | string | Yes | Profile type name. | -| participantPropertyReferences | array | Yes | The property references. - [ParticipantPropertyReference object](#ParticipantPropertyReference) | -| participantName | string | Yes | Participant name. | -| displayName | object | No | Localized display name. | -| description | object | No | Localized descriptions. | -| role | string | No | The role that the participant is playing in the interaction. | - - - -### ProfileEnumValidValuesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | integer | No | The integer value of the enum member. | -| localizedValueNames | object | No | Localized names of the enum member. | - - - -### ParticipantPropertyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourcePropertyName | string | Yes | The source property that maps to the target property. | -| targetPropertyName | string | Yes | The target property that maps to the source property. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/kpi.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/kpi.md deleted file mode 100644 index f9d2db9..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/kpi.md +++ /dev/null @@ -1,103 +0,0 @@ -# Microsoft.CustomerInsights/hubs/kpi template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/kpi resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/kpi", - "apiVersion": "2017-04-26", - "properties": { - "entityType": "string", - "entityTypeName": "string", - "displayName": {}, - "description": {}, - "calculationWindow": "string", - "calculationWindowFieldName": "string", - "function": "string", - "expression": "string", - "unit": "string", - "filter": "string", - "groupBy": [ - "string" - ], - "thresHolds": { - "lowerLimit": "number", - "upperLimit": "number", - "increasingKpi": "boolean" - }, - "aliases": [ - { - "aliasName": "string", - "expression": "string" - } - ], - "extracts": [ - { - "extractName": "string", - "expression": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/kpi object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/kpi | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [KpiDefinition object](#KpiDefinition) | - - - -### KpiDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| entityType | enum | Yes | The mapping entity type. - None, Profile, Interaction, Relationship | -| entityTypeName | string | Yes | The mapping entity name. | -| displayName | object | No | Localized display name for the KPI. | -| description | object | No | Localized description for the KPI. | -| calculationWindow | enum | Yes | The calculation window. - Lifetime, Hour, Day, Week, Month | -| calculationWindowFieldName | string | No | Name of calculation window field. | -| function | enum | Yes | The computation function for the KPI. - Sum, Avg, Min, Max, Last, Count, None, CountDistinct | -| expression | string | Yes | The computation expression for the KPI. | -| unit | string | No | The unit of measurement for the KPI. | -| filter | string | No | The filter expression for the KPI. | -| groupBy | array | No | the group by properties for the KPI. - string | -| thresHolds | object | No | The KPI thresholds. - [KpiThresholds object](#KpiThresholds) | -| aliases | array | No | The aliases. - [KpiAlias object](#KpiAlias) | -| extracts | array | No | The KPI extracts. - [KpiExtract object](#KpiExtract) | - - - -### KpiThresholds object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lowerLimit | number | Yes | The lower threshold limit. | -| upperLimit | number | Yes | The upper threshold limit. | -| increasingKpi | boolean | Yes | Whether or not the KPI is an increasing KPI. | - - - -### KpiAlias object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| aliasName | string | Yes | KPI alias name. | -| expression | string | Yes | The expression. | - - - -### KpiExtract object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| extractName | string | Yes | KPI extract name. | -| expression | string | Yes | The expression. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/links.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/links.md deleted file mode 100644 index 6b3a397..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/links.md +++ /dev/null @@ -1,82 +0,0 @@ -# Microsoft.CustomerInsights/hubs/links template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/links resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/links", - "apiVersion": "2017-04-26", - "properties": { - "sourceEntityType": "string", - "targetEntityType": "string", - "sourceEntityTypeName": "string", - "targetEntityTypeName": "string", - "displayName": {}, - "description": {}, - "mappings": [ - { - "sourcePropertyName": "string", - "targetPropertyName": "string", - "linkType": "string" - } - ], - "participantPropertyReferences": [ - { - "sourcePropertyName": "string", - "targetPropertyName": "string" - } - ], - "referenceOnly": "boolean", - "operationType": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/links object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/links | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [LinkDefinition object](#LinkDefinition) | - - - -### LinkDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceEntityType | enum | Yes | Type of source entity. - None, Profile, Interaction, Relationship | -| targetEntityType | enum | Yes | Type of target entity. - None, Profile, Interaction, Relationship | -| sourceEntityTypeName | string | Yes | Name of the source Entity Type. | -| targetEntityTypeName | string | Yes | Name of the target Entity Type. | -| displayName | object | No | Localized display name for the Link. | -| description | object | No | Localized descriptions for the Link. | -| mappings | array | No | The set of properties mappings between the source and target Types. - [TypePropertiesMapping object](#TypePropertiesMapping) | -| participantPropertyReferences | array | Yes | The properties that represent the participating profile. - [ParticipantPropertyReference object](#ParticipantPropertyReference) | -| referenceOnly | boolean | No | Indicating whether the link is reference only link. This flag is ingored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles. | -| operationType | enum | No | Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only. - Upsert or Delete | - - - -### TypePropertiesMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourcePropertyName | string | Yes | Property name on the source Entity Type. | -| targetPropertyName | string | Yes | Property name on the target Entity Type. | -| linkType | enum | No | Link type. - UpdateAlways or CopyIfNull | - - - -### ParticipantPropertyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourcePropertyName | string | Yes | The source property that maps to the target property. | -| targetPropertyName | string | Yes | The target property that maps to the source property. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/predictions.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/predictions.md deleted file mode 100644 index e4a0b6a..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/predictions.md +++ /dev/null @@ -1,96 +0,0 @@ -# Microsoft.CustomerInsights/hubs/predictions template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/predictions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/predictions", - "apiVersion": "2017-04-26", - "properties": { - "description": {}, - "displayName": {}, - "involvedInteractionTypes": [ - "string" - ], - "involvedKpiTypes": [ - "string" - ], - "involvedRelationships": [ - "string" - ], - "negativeOutcomeExpression": "string", - "positiveOutcomeExpression": "string", - "primaryProfileType": "string", - "predictionName": "string", - "scopeExpression": "string", - "autoAnalyze": "boolean", - "mappings": { - "score": "string", - "grade": "string", - "reason": "string" - }, - "scoreLabel": "string", - "grades": [ - { - "gradeName": "string", - "minScoreThreshold": "integer", - "maxScoreThreshold": "integer" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/predictions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/predictions | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [Prediction object](#Prediction) | - - - -### Prediction object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | object | No | Description of the prediction. | -| displayName | object | No | Display name of the prediction. | -| involvedInteractionTypes | array | No | Interaction types involved in the prediction. - string | -| involvedKpiTypes | array | No | KPI types involved in the prediction. - string | -| involvedRelationships | array | No | Relationships involved in the prediction. - string | -| negativeOutcomeExpression | string | Yes | Negative outcome expression. | -| positiveOutcomeExpression | string | Yes | Positive outcome expression. | -| primaryProfileType | string | Yes | Primary profile type. | -| predictionName | string | No | Name of the prediction. | -| scopeExpression | string | Yes | Scope expression. | -| autoAnalyze | boolean | Yes | Whether do auto analyze. | -| mappings | object | Yes | Definition of the link mapping of prediction. - [PredictionMappings object](#PredictionMappings) | -| scoreLabel | string | Yes | Score label. | -| grades | array | No | The prediction grades. - [PredictionGradesItem object](#PredictionGradesItem) | - - - -### PredictionMappings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| score | string | Yes | The score of the link mapping. | -| grade | string | Yes | The grade of the link mapping. | -| reason | string | Yes | The reason of the link mapping. | - - - -### PredictionGradesItem object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| gradeName | string | No | Name of the grade. | -| minScoreThreshold | integer | No | Minimum score threshold. | -| maxScoreThreshold | integer | No | Maximum score threshold. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/profiles.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/profiles.md deleted file mode 100644 index 55d71f5..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/profiles.md +++ /dev/null @@ -1,135 +0,0 @@ -# Microsoft.CustomerInsights/hubs/profiles template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/profiles resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/profiles", - "apiVersion": "2017-04-26", - "properties": { - "attributes": {}, - "description": {}, - "displayName": {}, - "localizedAttributes": {}, - "smallImage": "string", - "mediumImage": "string", - "largeImage": "string", - "apiEntitySetName": "string", - "entityType": "string", - "fields": [ - { - "arrayValueSeparator": "string", - "enumValidValues": [ - { - "value": "integer", - "localizedValueNames": {} - } - ], - "fieldName": "string", - "fieldType": "string", - "isArray": "boolean", - "isEnum": "boolean", - "isFlagEnum": "boolean", - "isImage": "boolean", - "isLocalizedString": "boolean", - "isName": "boolean", - "isRequired": "boolean", - "propertyId": "string", - "schemaItemPropLink": "string", - "maxLength": "integer", - "isAvailableInGraph": "boolean" - } - ], - "instancesCount": "integer", - "schemaItemTypeLink": "string", - "timestampFieldName": "string", - "typeName": "string", - "strongIds": [ - { - "keyPropertyNames": [ - "string" - ], - "strongIdName": "string", - "displayName": {}, - "description": {} - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/profiles object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/profiles | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [ProfileTypeDefinition object](#ProfileTypeDefinition) | - - - -### ProfileTypeDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| attributes | object | No | The attributes for the Type. | -| description | object | No | Localized descriptions for the property. | -| displayName | object | No | Localized display names for the property. | -| localizedAttributes | object | No | Any custom localized attributes for the Type. | -| smallImage | string | No | Small Image associated with the Property or EntityType. | -| mediumImage | string | No | Medium Image associated with the Property or EntityType. | -| largeImage | string | No | Large Image associated with the Property or EntityType. | -| apiEntitySetName | string | No | The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object. | -| entityType | enum | No | Type of entity. - None, Profile, Interaction, Relationship | -| fields | array | No | The properties of the Profile. - [PropertyDefinition object](#PropertyDefinition) | -| instancesCount | integer | No | The instance count. | -| schemaItemTypeLink | string | No | The schema org link. This helps ACI identify and suggest semantic models. | -| timestampFieldName | string | No | The timestamp property name. Represents the time when the interaction or profile update happened. | -| typeName | string | No | The name of the entity. | -| strongIds | array | No | The strong IDs. - [StrongId object](#StrongId) | - - - -### PropertyDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| arrayValueSeparator | string | No | Array value separator for properties with isArray set. | -| enumValidValues | array | No | Describes valid values for an enum property. - [ProfileEnumValidValuesFormat object](#ProfileEnumValidValuesFormat) | -| fieldName | string | Yes | Name of the property. | -| fieldType | string | Yes | Type of the property. | -| isArray | boolean | No | Indicates if the property is actually an array of the fieldType above on the data api. | -| isEnum | boolean | No | Indicates if the property is an enum. | -| isFlagEnum | boolean | No | Indicates if the property is an flag enum. | -| isImage | boolean | No | Whether the property is an Image. | -| isLocalizedString | boolean | No | Whether the property is a localized string. | -| isName | boolean | No | Whether the property is a name or a part of name. | -| isRequired | boolean | No | Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field. | -| propertyId | string | No | The ID associated with the property. | -| schemaItemPropLink | string | No | URL encoded schema.org item prop link for the property. | -| maxLength | integer | No | Max length of string. Used only if type is string. | -| isAvailableInGraph | boolean | No | Whether property is available in graph or not. | - - - -### StrongId object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyPropertyNames | array | Yes | The properties which make up the unique ID. - string | -| strongIdName | string | Yes | The Name identifying the strong ID. | -| displayName | object | No | Localized display name. | -| description | object | No | Localized descriptions. | - - - -### ProfileEnumValidValuesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | integer | No | The integer value of the enum member. | -| localizedValueNames | object | No | Localized names of the enum member. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/relationshipLinks.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/relationshipLinks.md deleted file mode 100644 index 5617f4a..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/relationshipLinks.md +++ /dev/null @@ -1,81 +0,0 @@ -# Microsoft.CustomerInsights/hubs/relationshipLinks template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/relationshipLinks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/relationshipLinks", - "apiVersion": "2017-04-26", - "properties": { - "displayName": {}, - "description": {}, - "interactionType": "string", - "mappings": [ - { - "interactionFieldName": "string", - "linkType": "string", - "relationshipFieldName": "string" - } - ], - "profilePropertyReferences": [ - { - "interactionPropertyName": "string", - "profilePropertyName": "string" - } - ], - "relatedProfilePropertyReferences": [ - { - "interactionPropertyName": "string", - "profilePropertyName": "string" - } - ], - "relationshipName": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/relationshipLinks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/relationshipLinks | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [RelationshipLinkDefinition object](#RelationshipLinkDefinition) | - - - -### RelationshipLinkDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| displayName | object | No | Localized display name for the Relationship Link. | -| description | object | No | Localized descriptions for the Relationship Link. | -| interactionType | string | Yes | The InteractionType associated with the Relationship Link. | -| mappings | array | No | The mappings between Interaction and Relationship fields. - [RelationshipLinkFieldMapping object](#RelationshipLinkFieldMapping) | -| profilePropertyReferences | array | Yes | The property references for the Profile of the Relationship. - [ParticipantProfilePropertyReference object](#ParticipantProfilePropertyReference) | -| relatedProfilePropertyReferences | array | Yes | The property references for the Related Profile of the Relationship. - [ParticipantProfilePropertyReference object](#ParticipantProfilePropertyReference) | -| relationshipName | string | Yes | The Relationship associated with the Link. | - - - -### RelationshipLinkFieldMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| interactionFieldName | string | Yes | The field name on the Interaction Type. | -| linkType | enum | No | Link type. - UpdateAlways or CopyIfNull | -| relationshipFieldName | string | Yes | The field name on the Relationship metadata. | - - - -### ParticipantProfilePropertyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| interactionPropertyName | string | Yes | The source interaction property that maps to the target profile property. | -| profilePropertyName | string | Yes | The target profile property that maps to the source interaction property. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/relationships.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/relationships.md deleted file mode 100644 index b34d3f8..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/relationships.md +++ /dev/null @@ -1,126 +0,0 @@ -# Microsoft.CustomerInsights/hubs/relationships template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/relationships resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/relationships", - "apiVersion": "2017-04-26", - "properties": { - "cardinality": "string", - "displayName": {}, - "description": {}, - "expiryDateTimeUtc": "string", - "fields": [ - { - "arrayValueSeparator": "string", - "enumValidValues": [ - { - "value": "integer", - "localizedValueNames": {} - } - ], - "fieldName": "string", - "fieldType": "string", - "isArray": "boolean", - "isEnum": "boolean", - "isFlagEnum": "boolean", - "isImage": "boolean", - "isLocalizedString": "boolean", - "isName": "boolean", - "isRequired": "boolean", - "propertyId": "string", - "schemaItemPropLink": "string", - "maxLength": "integer", - "isAvailableInGraph": "boolean" - } - ], - "lookupMappings": [ - { - "fieldMappings": [ - { - "profileFieldName": "string", - "relatedProfileKeyProperty": "string" - } - ] - } - ], - "profileType": "string", - "relatedProfileType": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/relationships object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/relationships | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [RelationshipDefinition object](#RelationshipDefinition) | - - - -### RelationshipDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| cardinality | enum | No | The Relationship Cardinality. - OneToOne, OneToMany, ManyToMany | -| displayName | object | No | Localized display name for the Relationship. | -| description | object | No | Localized descriptions for the Relationship. | -| expiryDateTimeUtc | string | No | The expiry date time in UTC. | -| fields | array | No | The properties of the Relationship. - [PropertyDefinition object](#PropertyDefinition) | -| lookupMappings | array | No | Optional property to be used to map fields in profile to their strong ids in related profile. - [RelationshipTypeMapping object](#RelationshipTypeMapping) | -| profileType | string | Yes | Profile type. | -| relatedProfileType | string | Yes | Related profile being referenced. | - - - -### PropertyDefinition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| arrayValueSeparator | string | No | Array value separator for properties with isArray set. | -| enumValidValues | array | No | Describes valid values for an enum property. - [ProfileEnumValidValuesFormat object](#ProfileEnumValidValuesFormat) | -| fieldName | string | Yes | Name of the property. | -| fieldType | string | Yes | Type of the property. | -| isArray | boolean | No | Indicates if the property is actually an array of the fieldType above on the data api. | -| isEnum | boolean | No | Indicates if the property is an enum. | -| isFlagEnum | boolean | No | Indicates if the property is an flag enum. | -| isImage | boolean | No | Whether the property is an Image. | -| isLocalizedString | boolean | No | Whether the property is a localized string. | -| isName | boolean | No | Whether the property is a name or a part of name. | -| isRequired | boolean | No | Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field. | -| propertyId | string | No | The ID associated with the property. | -| schemaItemPropLink | string | No | URL encoded schema.org item prop link for the property. | -| maxLength | integer | No | Max length of string. Used only if type is string. | -| isAvailableInGraph | boolean | No | Whether property is available in graph or not. | - - - -### RelationshipTypeMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fieldMappings | array | Yes | Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. - [RelationshipTypeFieldMapping object](#RelationshipTypeFieldMapping) | - - - -### ProfileEnumValidValuesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | integer | No | The integer value of the enum member. | -| localizedValueNames | object | No | Localized names of the enum member. | - - - -### RelationshipTypeFieldMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| profileFieldName | string | Yes | Specifies the fieldName in profile. | -| relatedProfileKeyProperty | string | Yes | Specifies the KeyProperty (from StrongId) of the related profile. | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/roleAssignments.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/roleAssignments.md deleted file mode 100644 index 413e655..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/roleAssignments.md +++ /dev/null @@ -1,182 +0,0 @@ -# Microsoft.CustomerInsights/hubs/roleAssignments template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/roleAssignments resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/roleAssignments", - "apiVersion": "2017-04-26", - "properties": { - "displayName": {}, - "description": {}, - "role": "string", - "principals": [ - { - "principalId": "string", - "principalType": "string", - "principalMetadata": {} - } - ], - "profiles": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "interactions": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "links": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "kpis": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "sasPolicies": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "connectors": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "views": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "relationshipLinks": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "relationships": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "widgetTypes": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "roleAssignments": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "conflationPolicies": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - }, - "segments": { - "elements": [ - "string" - ], - "exceptions": [ - "string" - ] - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/roleAssignments object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/roleAssignments | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [RoleAssignment object](#RoleAssignment) | - - - -### RoleAssignment object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| displayName | object | No | Localized display names for the metadata. | -| description | object | No | Localized description for the metadata. | -| role | enum | Yes | Type of roles. - Admin, Reader, ManageAdmin, ManageReader, DataAdmin, DataReader | -| principals | array | Yes | The principals being assigned to. - [AssignmentPrincipal object](#AssignmentPrincipal) | -| profiles | object | No | Profiles set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| interactions | object | No | Interactions set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| links | object | No | Links set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| kpis | object | No | Kpis set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| sasPolicies | object | No | Sas Policies set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| connectors | object | No | Connectors set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| views | object | No | Views set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| relationshipLinks | object | No | The Role assignments set for the relationship links. - [ResourceSetDescription object](#ResourceSetDescription) | -| relationships | object | No | The Role assignments set for the relationships. - [ResourceSetDescription object](#ResourceSetDescription) | -| widgetTypes | object | No | Widget types set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| roleAssignments | object | No | The Role assignments set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| conflationPolicies | object | No | Widget types set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | -| segments | object | No | The Role assignments set for the assignment. - [ResourceSetDescription object](#ResourceSetDescription) | - - - -### AssignmentPrincipal object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| principalId | string | Yes | The principal id being assigned to. | -| principalType | string | Yes | The Type of the principal ID. | -| principalMetadata | object | No | Other metadata for the principal. | - - - -### ResourceSetDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| elements | array | No | The elements included in the set. - string | -| exceptions | array | No | The elements that are not included in the set, in case elements contains '*' indicating 'all'. - string | - diff --git a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/views.md b/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/views.md deleted file mode 100644 index d42dd94..0000000 --- a/test/Resource/Expected/CustomerInsights/2017-04-26/hubs/views.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.CustomerInsights/hubs/views template reference -API Version: 2017-04-26 -## Template format - -To create a Microsoft.CustomerInsights/hubs/views resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CustomerInsights/hubs/views", - "apiVersion": "2017-04-26", - "properties": { - "userId": "string", - "displayName": {}, - "definition": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CustomerInsights/hubs/views object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CustomerInsights/hubs/views | -| apiVersion | enum | Yes | 2017-04-26 | -| properties | object | Yes | [View object](#View) | - - - -### View object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| userId | string | No | the user ID. | -| displayName | object | No | Localized display name for the view. | -| definition | string | Yes | View definition. | - diff --git a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/Microsoft.DevTestLab.json b/test/Resource/Expected/DevTestLabs/2015-05-21-preview/Microsoft.DevTestLab.json deleted file mode 100644 index a4c5aeb..0000000 --- a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/Microsoft.DevTestLab.json +++ /dev/null @@ -1,1820 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-05-21-preview/Microsoft.DevTestLab.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.DevTestLab", - "description": "Microsoft DevTestLab Resource Types", - "resourceDefinitions": { - "labs": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/labs_artifactsources_childResource" - }, - { - "$ref": "#/definitions/labs_customimages_childResource" - }, - { - "$ref": "#/definitions/labs_formulas_childResource" - }, - { - "$ref": "#/definitions/labs_schedules_childResource" - }, - { - "$ref": "#/definitions/labs_virtualmachines_childResource" - }, - { - "$ref": "#/definitions/labs_virtualnetworks_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs" - }, - "labs_artifactsources": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/artifactsources" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ArtifactSourceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/artifactsources" - }, - "labs_customimages": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/customimages" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CustomImageProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/customimages" - }, - "labs_formulas": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/formulas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FormulaProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/formulas" - }, - "labs_policysets_policies": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/policysets/policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/policysets/policies" - }, - "labs_schedules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/schedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/schedules" - }, - "labs_virtualmachines": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/virtualmachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabVirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualmachines" - }, - "labs_virtualnetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/virtualnetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualnetworks" - } - }, - "definitions": { - "ArtifactDeploymentStatusProperties": { - "type": "object", - "properties": { - "deploymentStatus": { - "type": "string", - "description": "The deployment status of the artifact." - }, - "artifactsApplied": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The total count of the artifacts that were successfully applied." - }, - "totalArtifacts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The total count of the artifacts that were tentatively applied." - } - }, - "description": "Properties of an artifact deployment." - }, - "ArtifactInstallProperties": { - "type": "object", - "properties": { - "artifactId": { - "type": "string", - "description": "The artifact's identifier." - }, - "parameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactParameterProperties" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The parameters of the artifact." - } - }, - "description": "Properties of an artifact." - }, - "ArtifactParameterProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the artifact parameter." - }, - "value": { - "type": "string", - "description": "The value of the artifact parameter." - } - }, - "description": "Properties of an artifact parameter." - }, - "ArtifactSourceProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the artifact source." - }, - "uri": { - "type": "string", - "description": "The URI of the artifact source." - }, - "sourceType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VsoGit", - "GitHub" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of the artifact source." - }, - "folderPath": { - "type": "string", - "description": "The folder path of the artifact source." - }, - "branchRef": { - "type": "string", - "description": "The branch reference of the artifact source." - }, - "securityToken": { - "type": "string", - "description": "The security token of the artifact source." - }, - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the artifact source." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - } - }, - "description": "Properties of an artifact source." - }, - "CustomImageProperties": { - "type": "object", - "properties": { - "vm": { - "oneOf": [ - { - "$ref": "#/definitions/CustomImagePropertiesFromVm" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/CustomImagePropertiesCustom" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The VHD from which the image is to be created." - }, - "description": { - "type": "string", - "description": "The description of the custom image." - }, - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The OS type of the custom image." - }, - "author": { - "type": "string", - "description": "The author of the custom image." - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The creation date of the custom image." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - } - }, - "description": "Properties of a custom image." - }, - "CustomImagePropertiesCustom": { - "type": "object", - "properties": { - "imageName": { - "type": "string", - "description": "The image name." - }, - "sysPrep": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether sysprep has been run on the VHD." - } - }, - "description": "Properties for creating a custom image from a VHD." - }, - "CustomImagePropertiesFromVm": { - "type": "object", - "properties": { - "sourceVmId": { - "type": "string", - "description": "The source vm identifier." - }, - "sysPrep": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether sysprep has been run on the VHD." - }, - "windowsOsInfo": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsOsInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Windows OS information of the VM." - }, - "linuxOsInfo": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxOsInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Linux OS information of the VM." - } - }, - "description": "Properties for creating a custom image from a virtual machine." - }, - "DayDetails": { - "type": "object", - "properties": { - "time": { - "type": "string" - } - }, - "description": "Properties of a daily schedule." - }, - "FormulaProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the formula." - }, - "author": { - "type": "string", - "description": "The author of the formula." - }, - "osType": { - "type": "string", - "description": "The OS type of the formula." - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The creation date of the formula." - }, - "formulaContent": { - "oneOf": [ - { - "$ref": "#/definitions/LabVirtualMachine" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The content of the formula." - }, - "vm": { - "oneOf": [ - { - "$ref": "#/definitions/FormulaPropertiesFromVm" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Information about a VM from which a formula is to be created." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - } - }, - "description": "Properties of a formula." - }, - "FormulaPropertiesFromVm": { - "type": "object", - "properties": { - "labVmId": { - "type": "string", - "description": "The identifier of the VM from which a formula is to be created." - } - }, - "description": "Information about a VM from which a formula is to be created." - }, - "GalleryImageReference": { - "type": "object", - "properties": { - "offer": { - "type": "string", - "description": "The offer of the gallery image." - }, - "publisher": { - "type": "string", - "description": "The publisher of the gallery image." - }, - "sku": { - "type": "string", - "description": "The SKU of the gallery image." - }, - "osType": { - "type": "string", - "description": "The OS type of the gallery image." - }, - "version": { - "type": "string", - "description": "The version of the gallery image." - } - }, - "description": "The reference information for an Azure Marketplace image." - }, - "HourDetails": { - "type": "object", - "properties": { - "minute": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minutes of the hour the schedule will run." - } - }, - "description": "Properties of an hourly schedule." - }, - "LabProperties": { - "type": "object", - "properties": { - "defaultStorageAccount": { - "type": "string", - "description": "The lab's default storage account." - }, - "artifactsStorageAccount": { - "type": "string", - "description": "The artifact storage account of the lab." - }, - "storageAccounts": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The storage accounts of the lab." - }, - "vaultName": { - "type": "string", - "description": "The name of the key vault of the lab." - }, - "labStorageType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of the lab storage." - }, - "defaultVirtualNetworkId": { - "type": "string", - "description": "The default virtual network identifier of the lab." - }, - "createdDate": { - "type": "string", - "format": "date-time", - "description": "The creation date of the lab." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - } - }, - "description": "Properties of a lab." - }, - "labs_artifactsources_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "artifactsources" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ArtifactSourceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/artifactsources" - }, - "labs_customimages_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "customimages" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CustomImageProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/customimages" - }, - "labs_formulas_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "formulas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FormulaProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/formulas" - }, - "labs_schedules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "schedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/schedules" - }, - "labs_virtualmachines_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualmachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabVirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualmachines" - }, - "labs_virtualnetworks_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualnetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-21-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualnetworks" - }, - "LabVirtualMachine": { - "type": "object", - "properties": { - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabVirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of the resource." - }, - "name": { - "type": "string", - "description": "The name of the resource." - }, - "type": { - "type": "string", - "description": "The type of the resource." - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "description": "A virtual machine." - }, - "LabVirtualMachineProperties": { - "type": "object", - "properties": { - "notes": { - "type": "string", - "description": "The notes of the virtual machine." - }, - "ownerObjectId": { - "type": "string", - "description": "The object identifier of the owner of the virtual machine." - }, - "createdByUserId": { - "type": "string", - "description": "The object identifier of the creator of the virtual machine." - }, - "createdByUser": { - "type": "string", - "description": "The email address of creator of the virtual machine." - }, - "computeId": { - "type": "string", - "description": "The resource identifier (Microsoft.Compute) of the virtual machine." - }, - "customImageId": { - "type": "string", - "description": "The custom image identifier of the virtual machine." - }, - "osType": { - "type": "string", - "description": "The OS type of the virtual machine." - }, - "size": { - "type": "string", - "description": "The size of the virtual machine." - }, - "userName": { - "type": "string", - "description": "The user name of the virtual machine." - }, - "password": { - "type": "string", - "description": "The password of the virtual machine administrator." - }, - "sshKey": { - "type": "string", - "description": "The SSH key of the virtual machine administrator." - }, - "isAuthenticationWithSshKey": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A value indicating whether this virtual machine uses an SSH key for authentication." - }, - "fqdn": { - "type": "string", - "description": "The fully-qualified domain name of the virtual machine." - }, - "labSubnetName": { - "type": "string", - "description": "The lab subnet name of the virtual machine." - }, - "labVirtualNetworkId": { - "type": "string", - "description": "The lab virtual network identifier of the virtual machine." - }, - "disallowPublicIpAddress": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether the virtual machine is to be created without a public IP address." - }, - "artifacts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactInstallProperties" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The artifacts to be installed on the virtual machine." - }, - "artifactDeploymentStatus": { - "oneOf": [ - { - "$ref": "#/definitions/ArtifactDeploymentStatusProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The artifact deployment status for the virtual machine." - }, - "galleryImageReference": { - "oneOf": [ - { - "$ref": "#/definitions/GalleryImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft Azure Marketplace image reference of the virtual machine." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - } - }, - "description": "Properties of a virtual machine." - }, - "LinuxOsInfo": { - "type": "object", - "properties": { - "linuxOsState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NonDeprovisioned", - "DeprovisionRequested", - "DeprovisionApplied" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of the Linux OS." - } - }, - "description": "Information about a Linux OS." - }, - "PolicyProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the policy." - }, - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the policy." - }, - "factName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UserOwnedLabVmCount", - "LabVmCount", - "LabVmSize", - "GalleryImage", - "UserOwnedLabVmCountInSubnet" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The fact name of the policy." - }, - "factData": { - "type": "string", - "description": "The fact data of the policy." - }, - "threshold": { - "type": "string", - "description": "The threshold of the policy." - }, - "evaluatorType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AllowedValuesPolicy", - "MaxValuePolicy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The evaluator type of the policy." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - } - }, - "description": "Properties of a Policy." - }, - "ScheduleProperties": { - "type": "object", - "properties": { - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the schedule." - }, - "taskType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "LabVmsShutdownTask", - "LabVmsStartupTask", - "LabBillingTask" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The task type of the schedule." - }, - "weeklyRecurrence": { - "oneOf": [ - { - "$ref": "#/definitions/WeekDetails" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The weekly recurrence of the schedule." - }, - "dailyRecurrence": { - "oneOf": [ - { - "$ref": "#/definitions/DayDetails" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The daily recurrence of the schedule." - }, - "hourlyRecurrence": { - "oneOf": [ - { - "$ref": "#/definitions/HourDetails" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The hourly recurrence of the schedule." - }, - "timeZoneId": { - "type": "string", - "description": "The time zone id." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - } - }, - "description": "Properties of a schedule." - }, - "Subnet": { - "type": "object", - "properties": { - "resourceId": { - "type": "string" - }, - "labSubnetName": { - "type": "string" - }, - "allowPublicIp": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "Deny", - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - } - }, - "SubnetOverride": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "description": "The resource identifier of the subnet." - }, - "labSubnetName": { - "type": "string", - "description": "The name given to the subnet within the lab." - }, - "useInVmCreationPermission": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "Deny", - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether this subnet can be used during virtual machine creation." - }, - "usePublicIpAddressPermission": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "Deny", - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether public IP addresses can be assigned to virtual machines on this subnet." - } - }, - "description": "Property overrides on a subnet of a virtual network." - }, - "VirtualNetworkProperties": { - "type": "object", - "properties": { - "allowedSubnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The allowed subnets of the virtual network." - }, - "description": { - "type": "string", - "description": "The description of the virtual network." - }, - "externalProviderResourceId": { - "type": "string", - "description": "The Microsoft.Network resource identifier of the virtual network." - }, - "subnetOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubnetOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The subnet overrides of the virtual network." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - } - }, - "description": "Properties of a virtual network." - }, - "WeekDetails": { - "type": "object", - "properties": { - "weekdays": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The days of the week." - }, - "time": { - "type": "string", - "description": "The time of the day." - } - }, - "description": "Properties of a weekly schedule." - }, - "WindowsOsInfo": { - "type": "object", - "properties": { - "windowsOsState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NonSysprepped", - "SysprepRequested", - "SysprepApplied" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of the Windows OS." - } - }, - "description": "Information about a Windows OS." - } - } -} diff --git a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs.md b/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs.md deleted file mode 100644 index 58e6761..0000000 --- a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs.md +++ /dev/null @@ -1,60 +0,0 @@ -# Microsoft.DevTestLab/labs template reference -API Version: 2015-05-21-preview -## Template format - -To create a Microsoft.DevTestLab/labs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs", - "apiVersion": "2015-05-21-preview", - "properties": { - "defaultStorageAccount": "string", - "artifactsStorageAccount": "string", - "storageAccounts": [ - "string" - ], - "vaultName": "string", - "labStorageType": "string", - "defaultVirtualNetworkId": "string", - "createdDate": "string", - "provisioningState": "string" - }, - "id": "string", - "location": "string", - "tags": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs | -| apiVersion | enum | Yes | 2015-05-21-preview | -| properties | object | Yes | The properties of the resource. - [LabProperties object](#LabProperties) | -| id | string | No | The identifier of the resource. | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| resources | array | No | [virtualnetworks](./labs/virtualnetworks.md) [virtualmachines](./labs/virtualmachines.md) [schedules](./labs/schedules.md) [formulas](./labs/formulas.md) [customimages](./labs/customimages.md) [artifactsources](./labs/artifactsources.md) | - - - -### LabProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultStorageAccount | string | No | The lab's default storage account. | -| artifactsStorageAccount | string | No | The artifact storage account of the lab. | -| storageAccounts | array | No | The storage accounts of the lab. - string | -| vaultName | string | No | The name of the key vault of the lab. | -| labStorageType | enum | No | The type of the lab storage. - Standard or Premium | -| defaultVirtualNetworkId | string | No | The default virtual network identifier of the lab. | -| createdDate | string | No | The creation date of the lab. | -| provisioningState | string | No | The provisioning status of the resource. | - diff --git a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/artifactsources.md b/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/artifactsources.md deleted file mode 100644 index 50c9edd..0000000 --- a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/artifactsources.md +++ /dev/null @@ -1,56 +0,0 @@ -# Microsoft.DevTestLab/labs/artifactsources template reference -API Version: 2015-05-21-preview -## Template format - -To create a Microsoft.DevTestLab/labs/artifactsources resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/artifactsources", - "apiVersion": "2015-05-21-preview", - "properties": { - "displayName": "string", - "uri": "string", - "sourceType": "string", - "folderPath": "string", - "branchRef": "string", - "securityToken": "string", - "status": "string", - "provisioningState": "string" - }, - "id": "string", - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/artifactsources object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/artifactsources | -| apiVersion | enum | Yes | 2015-05-21-preview | -| properties | object | Yes | The properties of the resource. - [ArtifactSourceProperties object](#ArtifactSourceProperties) | -| id | string | No | The identifier of the resource. | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | - - - -### ArtifactSourceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| displayName | string | No | The display name of the artifact source. | -| uri | string | No | The URI of the artifact source. | -| sourceType | enum | No | The type of the artifact source. - VsoGit or GitHub | -| folderPath | string | No | The folder path of the artifact source. | -| branchRef | string | No | The branch reference of the artifact source. | -| securityToken | string | No | The security token of the artifact source. | -| status | enum | No | The status of the artifact source. - Enabled or Disabled | -| provisioningState | string | No | The provisioning status of the resource. | - diff --git a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/customimages.md b/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/customimages.md deleted file mode 100644 index 0f32a30..0000000 --- a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/customimages.md +++ /dev/null @@ -1,98 +0,0 @@ -# Microsoft.DevTestLab/labs/customimages template reference -API Version: 2015-05-21-preview -## Template format - -To create a Microsoft.DevTestLab/labs/customimages resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/customimages", - "apiVersion": "2015-05-21-preview", - "properties": { - "vm": { - "sourceVmId": "string", - "sysPrep": "boolean", - "windowsOsInfo": { - "windowsOsState": "string" - }, - "linuxOsInfo": { - "linuxOsState": "string" - } - }, - "vhd": { - "imageName": "string", - "sysPrep": "boolean" - }, - "description": "string", - "osType": "string", - "author": "string", - "creationDate": "string", - "provisioningState": "string" - }, - "id": "string", - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/customimages object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/customimages | -| apiVersion | enum | Yes | 2015-05-21-preview | -| properties | object | Yes | The properties of the resource. - [CustomImageProperties object](#CustomImageProperties) | -| id | string | No | The identifier of the resource. | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | - - - -### CustomImageProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vm | object | No | [CustomImagePropertiesFromVm object](#CustomImagePropertiesFromVm) | -| vhd | object | No | The VHD from which the image is to be created. - [CustomImagePropertiesCustom object](#CustomImagePropertiesCustom) | -| description | string | No | The description of the custom image. | -| osType | enum | No | The OS type of the custom image. - Windows, Linux, None | -| author | string | No | The author of the custom image. | -| creationDate | string | No | The creation date of the custom image. | -| provisioningState | string | No | The provisioning status of the resource. | - - - -### CustomImagePropertiesFromVm object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVmId | string | No | The source vm identifier. | -| sysPrep | boolean | No | Indicates whether sysprep has been run on the VHD. | -| windowsOsInfo | object | No | The Windows OS information of the VM. - [WindowsOsInfo object](#WindowsOsInfo) | -| linuxOsInfo | object | No | The Linux OS information of the VM. - [LinuxOsInfo object](#LinuxOsInfo) | - - - -### CustomImagePropertiesCustom object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageName | string | No | The image name. | -| sysPrep | boolean | No | Indicates whether sysprep has been run on the VHD. | - - - -### WindowsOsInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| windowsOsState | enum | No | The state of the Windows OS. - NonSysprepped, SysprepRequested, SysprepApplied | - - - -### LinuxOsInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linuxOsState | enum | No | The state of the Linux OS. - NonDeprovisioned, DeprovisionRequested, DeprovisionApplied | - diff --git a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/formulas.md b/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/formulas.md deleted file mode 100644 index d0b402d..0000000 --- a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/formulas.md +++ /dev/null @@ -1,185 +0,0 @@ -# Microsoft.DevTestLab/labs/formulas template reference -API Version: 2015-05-21-preview -## Template format - -To create a Microsoft.DevTestLab/labs/formulas resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/formulas", - "apiVersion": "2015-05-21-preview", - "properties": { - "description": "string", - "author": "string", - "osType": "string", - "creationDate": "string", - "formulaContent": { - "properties": { - "notes": "string", - "ownerObjectId": "string", - "createdByUserId": "string", - "createdByUser": "string", - "computeId": "string", - "customImageId": "string", - "osType": "string", - "size": "string", - "userName": "string", - "password": "string", - "sshKey": "string", - "isAuthenticationWithSshKey": "boolean", - "fqdn": "string", - "labSubnetName": "string", - "labVirtualNetworkId": "string", - "disallowPublicIpAddress": "boolean", - "artifacts": [ - { - "artifactId": "string", - "parameters": [ - { - "name": "string", - "value": "string" - } - ] - } - ], - "artifactDeploymentStatus": { - "deploymentStatus": "string", - "artifactsApplied": "integer", - "totalArtifacts": "integer" - }, - "galleryImageReference": { - "offer": "string", - "publisher": "string", - "sku": "string", - "osType": "string", - "version": "string" - }, - "provisioningState": "string" - }, - "id": "string", - "name": "string", - "type": "string", - "location": "string", - "tags": {} - }, - "vm": { - "labVmId": "string" - }, - "provisioningState": "string" - }, - "id": "string", - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/formulas object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/formulas | -| apiVersion | enum | Yes | 2015-05-21-preview | -| properties | object | Yes | The properties of the resource. - [FormulaProperties object](#FormulaProperties) | -| id | string | No | The identifier of the resource. | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | - - - -### FormulaProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | The description of the formula. | -| author | string | No | The author of the formula. | -| osType | string | No | The OS type of the formula. | -| creationDate | string | No | The creation date of the formula. | -| formulaContent | object | No | The content of the formula. - [LabVirtualMachine object](#LabVirtualMachine) | -| vm | object | No | Information about a VM from which a formula is to be created. - [FormulaPropertiesFromVm object](#FormulaPropertiesFromVm) | -| provisioningState | string | No | The provisioning status of the resource. | - - - -### LabVirtualMachine object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| properties | object | No | The properties of the resource. - [LabVirtualMachineProperties object](#LabVirtualMachineProperties) | -| id | string | No | The identifier of the resource. | -| name | string | No | The name of the resource. | -| type | string | No | The type of the resource. | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | - - - -### FormulaPropertiesFromVm object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| labVmId | string | No | The identifier of the VM from which a formula is to be created. | - - - -### LabVirtualMachineProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| notes | string | No | The notes of the virtual machine. | -| ownerObjectId | string | No | The object identifier of the owner of the virtual machine. | -| createdByUserId | string | No | The object identifier of the creator of the virtual machine. | -| createdByUser | string | No | The email address of creator of the virtual machine. | -| computeId | string | No | The resource identifier (Microsoft.Compute) of the virtual machine. | -| customImageId | string | No | The custom image identifier of the virtual machine. | -| osType | string | No | The OS type of the virtual machine. | -| size | string | No | The size of the virtual machine. | -| userName | string | No | The user name of the virtual machine. | -| password | string | No | The password of the virtual machine administrator. | -| sshKey | string | No | The SSH key of the virtual machine administrator. | -| isAuthenticationWithSshKey | boolean | No | A value indicating whether this virtual machine uses an SSH key for authentication. | -| fqdn | string | No | The fully-qualified domain name of the virtual machine. | -| labSubnetName | string | No | The lab subnet name of the virtual machine. | -| labVirtualNetworkId | string | No | The lab virtual network identifier of the virtual machine. | -| disallowPublicIpAddress | boolean | No | Indicates whether the virtual machine is to be created without a public IP address. | -| artifacts | array | No | The artifacts to be installed on the virtual machine. - [ArtifactInstallProperties object](#ArtifactInstallProperties) | -| artifactDeploymentStatus | object | No | The artifact deployment status for the virtual machine. - [ArtifactDeploymentStatusProperties object](#ArtifactDeploymentStatusProperties) | -| galleryImageReference | object | No | The Microsoft Azure Marketplace image reference of the virtual machine. - [GalleryImageReference object](#GalleryImageReference) | -| provisioningState | string | No | The provisioning status of the resource. | - - - -### ArtifactInstallProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| artifactId | string | No | The artifact's identifier. | -| parameters | array | No | The parameters of the artifact. - [ArtifactParameterProperties object](#ArtifactParameterProperties) | - - - -### ArtifactDeploymentStatusProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| deploymentStatus | string | No | The deployment status of the artifact. | -| artifactsApplied | integer | No | The total count of the artifacts that were successfully applied. | -| totalArtifacts | integer | No | The total count of the artifacts that were tentatively applied. | - - - -### GalleryImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| offer | string | No | The offer of the gallery image. | -| publisher | string | No | The publisher of the gallery image. | -| sku | string | No | The SKU of the gallery image. | -| osType | string | No | The OS type of the gallery image. | -| version | string | No | The version of the gallery image. | - - - -### ArtifactParameterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the artifact parameter. | -| value | string | No | The value of the artifact parameter. | - diff --git a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/policysets/policies.md b/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/policysets/policies.md deleted file mode 100644 index 21ee15b..0000000 --- a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/policysets/policies.md +++ /dev/null @@ -1,54 +0,0 @@ -# Microsoft.DevTestLab/labs/policysets/policies template reference -API Version: 2015-05-21-preview -## Template format - -To create a Microsoft.DevTestLab/labs/policysets/policies resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/policysets/policies", - "apiVersion": "2015-05-21-preview", - "properties": { - "description": "string", - "status": "string", - "factName": "string", - "factData": "string", - "threshold": "string", - "evaluatorType": "string", - "provisioningState": "string" - }, - "id": "string", - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/policysets/policies object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/policysets/policies | -| apiVersion | enum | Yes | 2015-05-21-preview | -| properties | object | Yes | The properties of the resource. - [PolicyProperties object](#PolicyProperties) | -| id | string | No | The identifier of the resource. | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | - - - -### PolicyProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | The description of the policy. | -| status | enum | No | The status of the policy. - Enabled or Disabled | -| factName | enum | No | The fact name of the policy. - UserOwnedLabVmCount, LabVmCount, LabVmSize, GalleryImage, UserOwnedLabVmCountInSubnet | -| factData | string | No | The fact data of the policy. | -| threshold | string | No | The threshold of the policy. | -| evaluatorType | enum | No | The evaluator type of the policy. - AllowedValuesPolicy or MaxValuePolicy | -| provisioningState | string | No | The provisioning status of the resource. | - diff --git a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/schedules.md b/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/schedules.md deleted file mode 100644 index 90609e9..0000000 --- a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/schedules.md +++ /dev/null @@ -1,85 +0,0 @@ -# Microsoft.DevTestLab/labs/schedules template reference -API Version: 2015-05-21-preview -## Template format - -To create a Microsoft.DevTestLab/labs/schedules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/schedules", - "apiVersion": "2015-05-21-preview", - "properties": { - "status": "string", - "taskType": "string", - "weeklyRecurrence": { - "weekdays": [ - "string" - ], - "time": "string" - }, - "dailyRecurrence": { - "time": "string" - }, - "hourlyRecurrence": { - "minute": "integer" - }, - "timeZoneId": "string", - "provisioningState": "string" - }, - "id": "string", - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/schedules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/schedules | -| apiVersion | enum | Yes | 2015-05-21-preview | -| properties | object | Yes | The properties of the resource. - [ScheduleProperties object](#ScheduleProperties) | -| id | string | No | The identifier of the resource. | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | - - - -### ScheduleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | The status of the schedule. - Enabled or Disabled | -| taskType | enum | No | The task type of the schedule. - LabVmsShutdownTask, LabVmsStartupTask, LabBillingTask | -| weeklyRecurrence | object | No | The weekly recurrence of the schedule. - [WeekDetails object](#WeekDetails) | -| dailyRecurrence | object | No | The daily recurrence of the schedule. - [DayDetails object](#DayDetails) | -| hourlyRecurrence | object | No | The hourly recurrence of the schedule. - [HourDetails object](#HourDetails) | -| timeZoneId | string | No | The time zone id. | -| provisioningState | string | No | The provisioning status of the resource. | - - - -### WeekDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| weekdays | array | No | The days of the week. - string | -| time | string | No | The time of the day. | - - - -### DayDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| time | string | No | | - - - -### HourDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| minute | integer | No | Minutes of the hour the schedule will run. | - diff --git a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/virtualmachines.md b/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/virtualmachines.md deleted file mode 100644 index a6ba189..0000000 --- a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/virtualmachines.md +++ /dev/null @@ -1,136 +0,0 @@ -# Microsoft.DevTestLab/labs/virtualmachines template reference -API Version: 2015-05-21-preview -## Template format - -To create a Microsoft.DevTestLab/labs/virtualmachines resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/virtualmachines", - "apiVersion": "2015-05-21-preview", - "properties": { - "notes": "string", - "ownerObjectId": "string", - "createdByUserId": "string", - "createdByUser": "string", - "computeId": "string", - "customImageId": "string", - "osType": "string", - "size": "string", - "userName": "string", - "password": "string", - "sshKey": "string", - "isAuthenticationWithSshKey": "boolean", - "fqdn": "string", - "labSubnetName": "string", - "labVirtualNetworkId": "string", - "disallowPublicIpAddress": "boolean", - "artifacts": [ - { - "artifactId": "string", - "parameters": [ - { - "name": "string", - "value": "string" - } - ] - } - ], - "artifactDeploymentStatus": { - "deploymentStatus": "string", - "artifactsApplied": "integer", - "totalArtifacts": "integer" - }, - "galleryImageReference": { - "offer": "string", - "publisher": "string", - "sku": "string", - "osType": "string", - "version": "string" - }, - "provisioningState": "string" - }, - "id": "string", - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/virtualmachines object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/virtualmachines | -| apiVersion | enum | Yes | 2015-05-21-preview | -| properties | object | Yes | The properties of the resource. - [LabVirtualMachineProperties object](#LabVirtualMachineProperties) | -| id | string | No | The identifier of the resource. | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | - - - -### LabVirtualMachineProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| notes | string | No | The notes of the virtual machine. | -| ownerObjectId | string | No | The object identifier of the owner of the virtual machine. | -| createdByUserId | string | No | The object identifier of the creator of the virtual machine. | -| createdByUser | string | No | The email address of creator of the virtual machine. | -| computeId | string | No | The resource identifier (Microsoft.Compute) of the virtual machine. | -| customImageId | string | No | The custom image identifier of the virtual machine. | -| osType | string | No | The OS type of the virtual machine. | -| size | string | No | The size of the virtual machine. | -| userName | string | No | The user name of the virtual machine. | -| password | string | No | The password of the virtual machine administrator. | -| sshKey | string | No | The SSH key of the virtual machine administrator. | -| isAuthenticationWithSshKey | boolean | No | A value indicating whether this virtual machine uses an SSH key for authentication. | -| fqdn | string | No | The fully-qualified domain name of the virtual machine. | -| labSubnetName | string | No | The lab subnet name of the virtual machine. | -| labVirtualNetworkId | string | No | The lab virtual network identifier of the virtual machine. | -| disallowPublicIpAddress | boolean | No | Indicates whether the virtual machine is to be created without a public IP address. | -| artifacts | array | No | The artifacts to be installed on the virtual machine. - [ArtifactInstallProperties object](#ArtifactInstallProperties) | -| artifactDeploymentStatus | object | No | The artifact deployment status for the virtual machine. - [ArtifactDeploymentStatusProperties object](#ArtifactDeploymentStatusProperties) | -| galleryImageReference | object | No | The Microsoft Azure Marketplace image reference of the virtual machine. - [GalleryImageReference object](#GalleryImageReference) | -| provisioningState | string | No | The provisioning status of the resource. | - - - -### ArtifactInstallProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| artifactId | string | No | The artifact's identifier. | -| parameters | array | No | The parameters of the artifact. - [ArtifactParameterProperties object](#ArtifactParameterProperties) | - - - -### ArtifactDeploymentStatusProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| deploymentStatus | string | No | The deployment status of the artifact. | -| artifactsApplied | integer | No | The total count of the artifacts that were successfully applied. | -| totalArtifacts | integer | No | The total count of the artifacts that were tentatively applied. | - - - -### GalleryImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| offer | string | No | The offer of the gallery image. | -| publisher | string | No | The publisher of the gallery image. | -| sku | string | No | The SKU of the gallery image. | -| osType | string | No | The OS type of the gallery image. | -| version | string | No | The version of the gallery image. | - - - -### ArtifactParameterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the artifact parameter. | -| value | string | No | The value of the artifact parameter. | - diff --git a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/virtualnetworks.md b/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/virtualnetworks.md deleted file mode 100644 index b522a54..0000000 --- a/test/Resource/Expected/DevTestLabs/2015-05-21-preview/labs/virtualnetworks.md +++ /dev/null @@ -1,82 +0,0 @@ -# Microsoft.DevTestLab/labs/virtualnetworks template reference -API Version: 2015-05-21-preview -## Template format - -To create a Microsoft.DevTestLab/labs/virtualnetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/virtualnetworks", - "apiVersion": "2015-05-21-preview", - "properties": { - "allowedSubnets": [ - { - "resourceId": "string", - "labSubnetName": "string", - "allowPublicIp": "string" - } - ], - "description": "string", - "externalProviderResourceId": "string", - "subnetOverrides": [ - { - "resourceId": "string", - "labSubnetName": "string", - "useInVmCreationPermission": "string", - "usePublicIpAddressPermission": "string" - } - ], - "provisioningState": "string" - }, - "id": "string", - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/virtualnetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/virtualnetworks | -| apiVersion | enum | Yes | 2015-05-21-preview | -| properties | object | Yes | The properties of the resource. - [VirtualNetworkProperties object](#VirtualNetworkProperties) | -| id | string | No | The identifier of the resource. | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | - - - -### VirtualNetworkProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowedSubnets | array | No | The allowed subnets of the virtual network. - [Subnet object](#Subnet) | -| description | string | No | The description of the virtual network. | -| externalProviderResourceId | string | No | The Microsoft.Network resource identifier of the virtual network. | -| subnetOverrides | array | No | The subnet overrides of the virtual network. - [SubnetOverride object](#SubnetOverride) | -| provisioningState | string | No | The provisioning status of the resource. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| resourceId | string | No | | -| labSubnetName | string | No | | -| allowPublicIp | enum | No | Default, Deny, Allow | - - - -### SubnetOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| resourceId | string | No | The resource identifier of the subnet. | -| labSubnetName | string | No | The name given to the subnet within the lab. | -| useInVmCreationPermission | enum | No | Indicates whether this subnet can be used during virtual machine creation. - Default, Deny, Allow | -| usePublicIpAddressPermission | enum | No | Indicates whether public IP addresses can be assigned to virtual machines on this subnet. - Default, Deny, Allow | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/Microsoft.DevTestLab.json b/test/Resource/Expected/DevTestLabs/2016-05-15/Microsoft.DevTestLab.json deleted file mode 100644 index e4435ba..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/Microsoft.DevTestLab.json +++ /dev/null @@ -1,4049 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-05-15/Microsoft.DevTestLab.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.DevTestLab", - "description": "Microsoft DevTestLab Resource Types", - "resourceDefinitions": { - "labs": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/labs_artifactsources_childResource" - }, - { - "$ref": "#/definitions/labs_costs_childResource" - }, - { - "$ref": "#/definitions/labs_customimages_childResource" - }, - { - "$ref": "#/definitions/labs_formulas_childResource" - }, - { - "$ref": "#/definitions/labs_notificationchannels_childResource" - }, - { - "$ref": "#/definitions/labs_schedules_childResource" - }, - { - "$ref": "#/definitions/labs_servicerunners_childResource" - }, - { - "$ref": "#/definitions/labs_users_childResource" - }, - { - "$ref": "#/definitions/labs_virtualmachines_childResource" - }, - { - "$ref": "#/definitions/labs_virtualnetworks_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs" - }, - "labs_artifactsources": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/artifactsources" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ArtifactSourceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/artifactsources" - }, - "labs_costs": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/costs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabCostProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/costs" - }, - "labs_customimages": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/customimages" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CustomImageProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/customimages" - }, - "labs_formulas": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/formulas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FormulaProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/formulas" - }, - "labs_notificationchannels": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/notificationchannels" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NotificationChannelProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/notificationchannels" - }, - "labs_policysets_policies": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/policysets/policies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PolicyProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/policysets/policies" - }, - "labs_schedules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/schedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/schedules" - }, - "labs_servicerunners": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/servicerunners" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/IdentityProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.DevTestLab/labs/servicerunners" - }, - "labs_users": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/UserProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/labs_users_disks_childResource" - }, - { - "$ref": "#/definitions/labs_users_environments_childResource" - }, - { - "$ref": "#/definitions/labs_users_secrets_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/users" - }, - "labs_users_disks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/users/disks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DiskProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/users/disks" - }, - "labs_users_environments": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/users/environments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/EnvironmentProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/users/environments" - }, - "labs_users_secrets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/users/secrets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecretProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/users/secrets" - }, - "labs_virtualmachines": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/virtualmachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabVirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/labs_virtualmachines_schedules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualmachines" - }, - "labs_virtualmachines_schedules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/virtualmachines/schedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualmachines/schedules" - }, - "labs_virtualnetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/labs/virtualnetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualnetworks" - }, - "schedules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DevTestLab/schedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/schedules" - } - }, - "definitions": { - "ApplicableSchedule": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicableScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "properties" - ], - "description": "Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level." - }, - "ApplicableScheduleProperties": { - "type": "object", - "properties": { - "labVmsShutdown": { - "oneOf": [ - { - "$ref": "#/definitions/Schedule" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The auto-shutdown schedule, if one has been set at the lab or lab resource level." - }, - "labVmsStartup": { - "oneOf": [ - { - "$ref": "#/definitions/Schedule" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The auto-startup schedule, if one has been set at the lab or lab resource level." - } - }, - "description": "Properties of a schedules applicable to a virtual machine." - }, - "ArmTemplateParameterProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the template parameter." - }, - "value": { - "type": "string", - "description": "The value of the template parameter." - } - }, - "description": "Properties of an Azure Resource Manager template parameter." - }, - "ArtifactDeploymentStatusProperties": { - "type": "object", - "properties": { - "deploymentStatus": { - "type": "string", - "description": "The deployment status of the artifact." - }, - "artifactsApplied": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The total count of the artifacts that were successfully applied." - }, - "totalArtifacts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The total count of the artifacts that were tentatively applied." - } - }, - "description": "Properties of an artifact deployment." - }, - "ArtifactInstallProperties": { - "type": "object", - "properties": { - "artifactId": { - "type": "string", - "description": "The artifact's identifier." - }, - "parameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactParameterProperties" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The parameters of the artifact." - }, - "status": { - "type": "string", - "description": "The status of the artifact." - }, - "deploymentStatusMessage": { - "type": "string", - "description": "The status message from the deployment." - }, - "vmExtensionStatusMessage": { - "type": "string", - "description": "The status message from the virtual machine extension." - }, - "installTime": { - "type": "string", - "format": "date-time", - "description": "The time that the artifact starts to install on the virtual machine." - } - }, - "description": "Properties of an artifact." - }, - "ArtifactParameterProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the artifact parameter." - }, - "value": { - "type": "string", - "description": "The value of the artifact parameter." - } - }, - "description": "Properties of an artifact parameter." - }, - "ArtifactSourceProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The artifact source's display name." - }, - "uri": { - "type": "string", - "description": "The artifact source's URI." - }, - "sourceType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VsoGit", - "GitHub" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The artifact source's type." - }, - "folderPath": { - "type": "string", - "description": "The folder containing artifacts." - }, - "armTemplateFolderPath": { - "type": "string", - "description": "The folder containing Azure Resource Manager templates." - }, - "branchRef": { - "type": "string", - "description": "The artifact source's branch reference." - }, - "securityToken": { - "type": "string", - "description": "The security token to authenticate to the artifact source." - }, - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if the artifact source is enabled (values: Enabled, Disabled)." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of an artifact source." - }, - "BulkCreationParameters": { - "type": "object", - "properties": { - "instanceCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of virtual machine instances to create." - } - }, - "description": "Parameters for creating multiple virtual machines as a single action." - }, - "ComputeDataDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets data disk name." - }, - "diskUri": { - "type": "string", - "description": "When backed by a blob, the URI of underlying blob." - }, - "managedDiskId": { - "type": "string", - "description": "When backed by managed disk, this is the ID of the compute disk resource." - }, - "diskSizeGiB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets data disk size in GiB." - } - }, - "description": "A data disks attached to a virtual machine." - }, - "ComputeVmInstanceViewStatus": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Gets the status Code." - }, - "displayStatus": { - "type": "string", - "description": "Gets the short localizable label for the status." - }, - "message": { - "type": "string", - "description": "Gets the message associated with the status." - } - }, - "description": "Status information about a virtual machine." - }, - "ComputeVmProperties": { - "type": "object", - "properties": { - "statuses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ComputeVmInstanceViewStatus" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets the statuses of the virtual machine." - }, - "osType": { - "type": "string", - "description": "Gets the OS type of the virtual machine." - }, - "vmSize": { - "type": "string", - "description": "Gets the size of the virtual machine." - }, - "networkInterfaceId": { - "type": "string", - "description": "Gets the network interface ID of the virtual machine." - }, - "osDiskId": { - "type": "string", - "description": "Gets OS disk blob uri for the virtual machine." - }, - "dataDiskIds": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets data disks blob uri for the virtual machine." - }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ComputeDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets all data disks attached to the virtual machine." - } - }, - "description": "Properties of a virtual machine returned by the Microsoft.Compute API." - }, - "CostThresholdProperties": { - "type": "object", - "properties": { - "thresholdId": { - "type": "string", - "description": "The ID of the cost threshold item." - }, - "percentageThreshold": { - "oneOf": [ - { - "$ref": "#/definitions/PercentageCostThresholdProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value of the percentage cost threshold." - }, - "displayOnChart": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether this threshold will be displayed on cost charts." - }, - "sendNotificationWhenExceeded": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether notifications will be sent when this threshold is exceeded." - }, - "notificationSent": { - "type": "string", - "description": "Indicates the datetime when notifications were last sent for this threshold." - } - }, - "description": "Properties of a cost threshold item." - }, - "CustomImageProperties": { - "type": "object", - "properties": { - "vm": { - "oneOf": [ - { - "$ref": "#/definitions/CustomImagePropertiesFromVm" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The virtual machine from which the image is to be created." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/CustomImagePropertiesCustom" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The VHD from which the image is to be created." - }, - "description": { - "type": "string", - "description": "The description of the custom image." - }, - "author": { - "type": "string", - "description": "The author of the custom image." - }, - "managedImageId": { - "type": "string", - "description": "The Managed Image Id backing the custom image." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a custom image." - }, - "CustomImagePropertiesCustom": { - "type": "object", - "properties": { - "imageName": { - "type": "string", - "description": "The image name." - }, - "sysPrep": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether sysprep has been run on the VHD." - }, - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The OS type of the custom image (i.e. Windows, Linux)." - } - }, - "required": [ - "osType" - ], - "description": "Properties for creating a custom image from a VHD." - }, - "CustomImagePropertiesFromVm": { - "type": "object", - "properties": { - "sourceVmId": { - "type": "string", - "description": "The source vm identifier." - }, - "windowsOsInfo": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsOsInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Windows OS information of the VM." - }, - "linuxOsInfo": { - "oneOf": [ - { - "$ref": "#/definitions/LinuxOsInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Linux OS information of the VM." - } - }, - "description": "Properties for creating a custom image from a virtual machine." - }, - "DayDetails": { - "type": "object", - "properties": { - "time": { - "type": "string", - "description": "The time of day the schedule will occur." - } - }, - "description": "Properties of a daily schedule." - }, - "DiskProperties": { - "type": "object", - "properties": { - "diskType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The storage type for the disk (i.e. Standard, Premium)." - }, - "diskSizeGiB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The size of the disk in GibiBytes." - }, - "leasedByLabVmId": { - "type": "string", - "description": "The resource ID of the VM to which this disk is leased." - }, - "diskBlobName": { - "type": "string", - "description": "When backed by a blob, the name of the VHD blob without extension." - }, - "diskUri": { - "type": "string", - "description": "When backed by a blob, the URI of underlying blob." - }, - "hostCaching": { - "type": "string", - "description": "The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite)." - }, - "managedDiskId": { - "type": "string", - "description": "When backed by managed disk, this is the ID of the compute disk resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a disk." - }, - "EnvironmentDeploymentProperties": { - "type": "object", - "properties": { - "armTemplateId": { - "type": "string", - "description": "The Azure Resource Manager template's identifier." - }, - "parameters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ArmTemplateParameterProperties" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The parameters of the Azure Resource Manager template." - } - }, - "description": "Properties of an environment deployment." - }, - "EnvironmentProperties": { - "type": "object", - "properties": { - "deploymentProperties": { - "oneOf": [ - { - "$ref": "#/definitions/EnvironmentDeploymentProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The deployment properties of the environment." - }, - "armTemplateDisplayName": { - "type": "string", - "description": "The display name of the Azure Resource Manager template that produced the environment." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of an environment." - }, - "Event": { - "type": "object", - "properties": { - "eventName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AutoShutdown", - "Cost" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The event type for which this notification is enabled (i.e. AutoShutdown, Cost)." - } - }, - "description": "An event to be notified for." - }, - "ExternalSubnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the identifier." - }, - "name": { - "type": "string", - "description": "Gets or sets the name." - } - }, - "description": "Subnet information as returned by the Microsoft.Network API." - }, - "FormulaProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the formula." - }, - "author": { - "type": "string", - "description": "The author of the formula." - }, - "osType": { - "type": "string", - "description": "The OS type of the formula." - }, - "formulaContent": { - "oneOf": [ - { - "$ref": "#/definitions/LabVirtualMachineCreationParameter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The content of the formula." - }, - "vm": { - "oneOf": [ - { - "$ref": "#/definitions/FormulaPropertiesFromVm" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Information about a VM from which a formula is to be created." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a formula." - }, - "FormulaPropertiesFromVm": { - "type": "object", - "properties": { - "labVmId": { - "type": "string", - "description": "The identifier of the VM from which a formula is to be created." - } - }, - "description": "Information about a VM from which a formula is to be created." - }, - "GalleryImageReference": { - "type": "object", - "properties": { - "offer": { - "type": "string", - "description": "The offer of the gallery image." - }, - "publisher": { - "type": "string", - "description": "The publisher of the gallery image." - }, - "sku": { - "type": "string", - "description": "The SKU of the gallery image." - }, - "osType": { - "type": "string", - "description": "The OS type of the gallery image." - }, - "version": { - "type": "string", - "description": "The version of the gallery image." - } - }, - "description": "The reference information for an Azure Marketplace image." - }, - "HourDetails": { - "type": "object", - "properties": { - "minute": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minutes of the hour the schedule will run." - } - }, - "description": "Properties of an hourly schedule." - }, - "IdentityProperties": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Managed identity." - }, - "principalId": { - "type": "string", - "description": "The principal id of resource identity." - }, - "tenantId": { - "type": "string", - "description": "The tenant identifier of resource." - }, - "clientSecretUrl": { - "type": "string", - "description": "The client secret URL of the identity." - } - }, - "description": "Properties of a managed identity" - }, - "InboundNatRule": { - "type": "object", - "properties": { - "transportProtocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port to which the external traffic will be redirected." - } - }, - "description": "A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer." - }, - "LabCostProperties": { - "type": "object", - "properties": { - "targetCost": { - "oneOf": [ - { - "$ref": "#/definitions/TargetCostProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The target cost properties" - }, - "currencyCode": { - "type": "string", - "description": "The currency code of the cost." - }, - "startDateTime": { - "type": "string", - "format": "date-time", - "description": "The start time of the cost data." - }, - "endDateTime": { - "type": "string", - "format": "date-time", - "description": "The end time of the cost data." - }, - "createdDate": { - "type": "string", - "format": "date-time", - "description": "The creation date of the cost." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a cost item." - }, - "LabProperties": { - "type": "object", - "properties": { - "labStorageType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of storage used by the lab. It can be either Premium or Standard. Default is Premium." - }, - "premiumDataDisks": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The setting to enable usage of premium data disks.\r\nWhen its value is 'Enabled', creation of standard or premium data disks is allowed.\r\nWhen its value is 'Disabled', only creation of standard data disks is allowed." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a lab." - }, - "labs_artifactsources_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "artifactsources" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ArtifactSourceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/artifactsources" - }, - "labs_costs_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "costs" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabCostProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/costs" - }, - "labs_customimages_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "customimages" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CustomImageProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/customimages" - }, - "labs_formulas_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "formulas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FormulaProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/formulas" - }, - "labs_notificationchannels_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "notificationchannels" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NotificationChannelProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/notificationchannels" - }, - "labs_schedules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "schedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/schedules" - }, - "labs_servicerunners_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "servicerunners" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/IdentityProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.DevTestLab/labs/servicerunners" - }, - "labs_users_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "users" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/UserProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/users" - }, - "labs_users_disks_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "disks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DiskProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/users/disks" - }, - "labs_users_environments_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "environments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/EnvironmentProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/users/environments" - }, - "labs_users_secrets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "secrets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecretProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/users/secrets" - }, - "labs_virtualmachines_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualmachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabVirtualMachineProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualmachines" - }, - "labs_virtualmachines_schedules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "schedules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualmachines/schedules" - }, - "labs_virtualnetworks_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualnetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DevTestLab/labs/virtualnetworks" - }, - "LabVirtualMachineCreationParameter": { - "type": "object", - "properties": { - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LabVirtualMachineCreationParameterProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - }, - "name": { - "type": "string", - "description": "The name of the virtual machine or environment" - }, - "location": { - "type": "string", - "description": "The location of the new virtual machine or environment" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - } - }, - "description": "Properties for creating a virtual machine." - }, - "LabVirtualMachineCreationParameterProperties": { - "type": "object", - "properties": { - "bulkCreationParameters": { - "oneOf": [ - { - "$ref": "#/definitions/BulkCreationParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of virtual machine instances to create." - }, - "notes": { - "type": "string", - "description": "The notes of the virtual machine." - }, - "ownerObjectId": { - "type": "string", - "description": "The object identifier of the owner of the virtual machine." - }, - "ownerUserPrincipalName": { - "type": "string", - "description": "The user principal name of the virtual machine owner." - }, - "createdByUserId": { - "type": "string", - "description": "The object identifier of the creator of the virtual machine." - }, - "createdByUser": { - "type": "string", - "description": "The email address of creator of the virtual machine." - }, - "createdDate": { - "type": "string", - "format": "date-time", - "description": "The creation date of the virtual machine." - }, - "customImageId": { - "type": "string", - "description": "The custom image identifier of the virtual machine." - }, - "osType": { - "type": "string", - "description": "The OS type of the virtual machine." - }, - "size": { - "type": "string", - "description": "The size of the virtual machine." - }, - "userName": { - "type": "string", - "description": "The user name of the virtual machine." - }, - "password": { - "type": "string", - "description": "The password of the virtual machine administrator." - }, - "sshKey": { - "type": "string", - "description": "The SSH key of the virtual machine administrator." - }, - "isAuthenticationWithSshKey": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether this virtual machine uses an SSH key for authentication." - }, - "fqdn": { - "type": "string", - "description": "The fully-qualified domain name of the virtual machine." - }, - "labSubnetName": { - "type": "string", - "description": "The lab subnet name of the virtual machine." - }, - "labVirtualNetworkId": { - "type": "string", - "description": "The lab virtual network identifier of the virtual machine." - }, - "disallowPublicIpAddress": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether the virtual machine is to be created without a public IP address." - }, - "artifacts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactInstallProperties" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The artifacts to be installed on the virtual machine." - }, - "artifactDeploymentStatus": { - "oneOf": [ - { - "$ref": "#/definitions/ArtifactDeploymentStatusProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The artifact deployment status for the virtual machine." - }, - "galleryImageReference": { - "oneOf": [ - { - "$ref": "#/definitions/GalleryImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft Azure Marketplace image reference of the virtual machine." - }, - "computeVm": { - "oneOf": [ - { - "$ref": "#/definitions/ComputeVmProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The compute virtual machine properties." - }, - "networkInterface": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network interface properties." - }, - "applicableSchedule": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicableSchedule" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The applicable schedule for the virtual machine." - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The expiration date for VM." - }, - "allowClaim": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether another user can take ownership of the virtual machine" - }, - "storageType": { - "type": "string", - "description": "Storage type to use for virtual machine (i.e. Standard, Premium)." - }, - "virtualMachineCreationSource": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromCustomImage", - "FromGalleryImage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tells source of creation of lab virtual machine. Output property only." - }, - "environmentId": { - "type": "string", - "description": "The resource ID of the environment that contains this virtual machine, if any." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties for virtual machine creation." - }, - "LabVirtualMachineProperties": { - "type": "object", - "properties": { - "notes": { - "type": "string", - "description": "The notes of the virtual machine." - }, - "ownerObjectId": { - "type": "string", - "description": "The object identifier of the owner of the virtual machine." - }, - "ownerUserPrincipalName": { - "type": "string", - "description": "The user principal name of the virtual machine owner." - }, - "createdByUserId": { - "type": "string", - "description": "The object identifier of the creator of the virtual machine." - }, - "createdByUser": { - "type": "string", - "description": "The email address of creator of the virtual machine." - }, - "createdDate": { - "type": "string", - "format": "date-time", - "description": "The creation date of the virtual machine." - }, - "customImageId": { - "type": "string", - "description": "The custom image identifier of the virtual machine." - }, - "osType": { - "type": "string", - "description": "The OS type of the virtual machine." - }, - "size": { - "type": "string", - "description": "The size of the virtual machine." - }, - "userName": { - "type": "string", - "description": "The user name of the virtual machine." - }, - "password": { - "type": "string", - "description": "The password of the virtual machine administrator." - }, - "sshKey": { - "type": "string", - "description": "The SSH key of the virtual machine administrator." - }, - "isAuthenticationWithSshKey": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether this virtual machine uses an SSH key for authentication." - }, - "fqdn": { - "type": "string", - "description": "The fully-qualified domain name of the virtual machine." - }, - "labSubnetName": { - "type": "string", - "description": "The lab subnet name of the virtual machine." - }, - "labVirtualNetworkId": { - "type": "string", - "description": "The lab virtual network identifier of the virtual machine." - }, - "disallowPublicIpAddress": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether the virtual machine is to be created without a public IP address." - }, - "artifacts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ArtifactInstallProperties" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The artifacts to be installed on the virtual machine." - }, - "artifactDeploymentStatus": { - "oneOf": [ - { - "$ref": "#/definitions/ArtifactDeploymentStatusProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The artifact deployment status for the virtual machine." - }, - "galleryImageReference": { - "oneOf": [ - { - "$ref": "#/definitions/GalleryImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft Azure Marketplace image reference of the virtual machine." - }, - "computeVm": { - "oneOf": [ - { - "$ref": "#/definitions/ComputeVmProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The compute virtual machine properties." - }, - "networkInterface": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network interface properties." - }, - "applicableSchedule": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicableSchedule" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The applicable schedule for the virtual machine." - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The expiration date for VM." - }, - "allowClaim": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether another user can take ownership of the virtual machine" - }, - "storageType": { - "type": "string", - "description": "Storage type to use for virtual machine (i.e. Standard, Premium)." - }, - "virtualMachineCreationSource": { - "oneOf": [ - { - "type": "string", - "enum": [ - "FromCustomImage", - "FromGalleryImage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tells source of creation of lab virtual machine. Output property only." - }, - "environmentId": { - "type": "string", - "description": "The resource ID of the environment that contains this virtual machine, if any." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a virtual machine." - }, - "LinuxOsInfo": { - "type": "object", - "properties": { - "linuxOsState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NonDeprovisioned", - "DeprovisionRequested", - "DeprovisionApplied" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied)." - } - }, - "description": "Information about a Linux OS." - }, - "NetworkInterfaceProperties": { - "type": "object", - "properties": { - "virtualNetworkId": { - "type": "string", - "description": "The resource ID of the virtual network." - }, - "subnetId": { - "type": "string", - "description": "The resource ID of the sub net." - }, - "publicIpAddressId": { - "type": "string", - "description": "The resource ID of the public IP address." - }, - "publicIpAddress": { - "type": "string", - "description": "The public IP address." - }, - "privateIpAddress": { - "type": "string", - "description": "The private IP address." - }, - "dnsName": { - "type": "string", - "description": "The DNS name." - }, - "rdpAuthority": { - "type": "string", - "description": "The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol)." - }, - "sshAuthority": { - "type": "string", - "description": "The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH." - }, - "sharedPublicIpAddressConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SharedPublicIpAddressConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The configuration for sharing a public IP address across multiple virtual machines." - } - }, - "description": "Properties of a network interface." - }, - "NotificationChannelProperties": { - "type": "object", - "properties": { - "webHookUrl": { - "type": "string", - "description": "The webhook URL to send notifications to." - }, - "description": { - "type": "string", - "description": "Description of notification." - }, - "events": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Event" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of event for which this notification is enabled." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a schedule." - }, - "NotificationSettings": { - "type": "object", - "properties": { - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If notifications are enabled for this schedule (i.e. Enabled, Disabled)." - }, - "timeInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Time in minutes before event at which notification will be sent." - }, - "webhookUrl": { - "type": "string", - "description": "The webhook URL to which the notification will be sent." - } - }, - "description": "Notification settings for a schedule." - }, - "PercentageCostThresholdProperties": { - "type": "object", - "properties": { - "thresholdValue": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The cost threshold value." - } - }, - "description": "Properties of a percentage cost threshold." - }, - "PolicyProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the policy." - }, - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the policy." - }, - "factName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UserOwnedLabVmCount", - "UserOwnedLabPremiumVmCount", - "LabVmCount", - "LabPremiumVmCount", - "LabVmSize", - "GalleryImage", - "UserOwnedLabVmCountInSubnet", - "LabTargetCost" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc." - }, - "factData": { - "type": "string", - "description": "The fact data of the policy." - }, - "threshold": { - "type": "string", - "description": "The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy)." - }, - "evaluatorType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AllowedValuesPolicy", - "MaxValuePolicy" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy)." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a Policy." - }, - "Port": { - "type": "object", - "properties": { - "transportProtocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol type of the port." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend port of the target virtual machine." - } - }, - "description": "Properties of a network port." - }, - "Schedule": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tags of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ScheduleProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The properties of the resource." - } - }, - "required": [ - "properties" - ], - "description": "A schedule." - }, - "ScheduleProperties": { - "type": "object", - "properties": { - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the schedule (i.e. Enabled, Disabled)." - }, - "taskType": { - "type": "string", - "description": "The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart)." - }, - "weeklyRecurrence": { - "oneOf": [ - { - "$ref": "#/definitions/WeekDetails" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the schedule will occur only some days of the week, specify the weekly recurrence." - }, - "dailyRecurrence": { - "oneOf": [ - { - "$ref": "#/definitions/DayDetails" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the schedule will occur once each day of the week, specify the daily recurrence." - }, - "hourlyRecurrence": { - "oneOf": [ - { - "$ref": "#/definitions/HourDetails" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the schedule will occur multiple times a day, specify the hourly recurrence." - }, - "timeZoneId": { - "type": "string", - "description": "The time zone ID (e.g. Pacific Standard time)." - }, - "notificationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NotificationSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Notification settings." - }, - "targetResourceId": { - "type": "string", - "description": "The resource ID to which the schedule belongs" - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a schedule." - }, - "SecretProperties": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "The value of the secret for secret creation." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a secret." - }, - "SharedPublicIpAddressConfiguration": { - "type": "object", - "properties": { - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The incoming NAT rules" - } - }, - "description": "Properties of a virtual machine that determine how it is connected to a load balancer." - }, - "Subnet": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "description": "The resource ID of the subnet." - }, - "labSubnetName": { - "type": "string", - "description": "The name of the subnet as seen in the lab." - }, - "allowPublicIp": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "Deny", - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny))." - } - }, - "description": "Subnet information." - }, - "SubnetOverride": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "description": "The resource ID of the subnet." - }, - "labSubnetName": { - "type": "string", - "description": "The name given to the subnet within the lab." - }, - "useInVmCreationPermission": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "Deny", - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny)." - }, - "usePublicIpAddressPermission": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "Deny", - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny)." - }, - "sharedPublicIpAddressConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetSharedPublicIpAddressConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties that virtual machines on this subnet will share." - }, - "virtualNetworkPoolName": { - "type": "string", - "description": "The virtual network pool associated with this subnet." - } - }, - "description": "Property overrides on a subnet of a virtual network." - }, - "SubnetSharedPublicIpAddressConfiguration": { - "type": "object", - "properties": { - "allowedPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Port" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend ports that virtual machines on this subnet are allowed to expose" - } - }, - "description": "Configuration for public IP address sharing." - }, - "TargetCostProperties": { - "type": "object", - "properties": { - "status": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Target cost status." - }, - "target": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Lab target cost" - }, - "costThresholds": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/CostThresholdProperties" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cost thresholds." - }, - "cycleStartDateTime": { - "type": "string", - "format": "date-time", - "description": "Reporting cycle start date." - }, - "cycleEndDateTime": { - "type": "string", - "format": "date-time", - "description": "Reporting cycle end date." - }, - "cycleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "CalendarMonth", - "Custom" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reporting cycle type." - } - }, - "description": "Properties of a cost target." - }, - "UserIdentity": { - "type": "object", - "properties": { - "principalName": { - "type": "string", - "description": "Set to the principal name / UPN of the client JWT making the request." - }, - "principalId": { - "type": "string", - "description": "Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id." - }, - "tenantId": { - "type": "string", - "description": "Set to the tenant ID of the client JWT making the request." - }, - "objectId": { - "type": "string", - "description": "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." - }, - "appId": { - "type": "string", - "description": "Set to the app Id of the client JWT making the request." - } - }, - "description": "Identity attributes of a lab user." - }, - "UserProperties": { - "type": "object", - "properties": { - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/UserIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the user." - }, - "secretStore": { - "oneOf": [ - { - "$ref": "#/definitions/UserSecretStore" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The secret store of the user." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a lab user profile." - }, - "UserSecretStore": { - "type": "object", - "properties": { - "keyVaultUri": { - "type": "string", - "description": "The URI of the user's Key vault." - }, - "keyVaultId": { - "type": "string", - "description": "The ID of the user's Key vault." - } - }, - "description": "Properties of a user's secret store." - }, - "VirtualNetworkProperties": { - "type": "object", - "properties": { - "allowedSubnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The allowed subnets of the virtual network." - }, - "description": { - "type": "string", - "description": "The description of the virtual network." - }, - "externalProviderResourceId": { - "type": "string", - "description": "The Microsoft.Network resource identifier of the virtual network." - }, - "externalSubnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExternalSubnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The external subnet properties." - }, - "subnetOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubnetOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The subnet overrides of the virtual network." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning status of the resource." - }, - "uniqueIdentifier": { - "type": "string", - "description": "The unique immutable identifier of a resource (Guid)." - } - }, - "description": "Properties of a virtual network." - }, - "WeekDetails": { - "type": "object", - "properties": { - "weekdays": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.)." - }, - "time": { - "type": "string", - "description": "The time of the day the schedule will occur." - } - }, - "description": "Properties of a weekly schedule." - }, - "WindowsOsInfo": { - "type": "object", - "properties": { - "windowsOsState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NonSysprepped", - "SysprepRequested", - "SysprepApplied" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied)." - } - }, - "description": "Information about a Windows OS." - } - } -} diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs.md deleted file mode 100644 index 2570987..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs.md +++ /dev/null @@ -1,50 +0,0 @@ -# Microsoft.DevTestLab/labs template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "labStorageType": "string", - "premiumDataDisks": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [LabProperties object](#LabProperties) | -| resources | array | No | [virtualnetworks](./labs/virtualnetworks.md) [virtualmachines](./labs/virtualmachines.md) [users](./labs/users.md) [servicerunners](./labs/servicerunners.md) [schedules](./labs/schedules.md) [notificationchannels](./labs/notificationchannels.md) [formulas](./labs/formulas.md) [customimages](./labs/customimages.md) [costs](./labs/costs.md) [artifactsources](./labs/artifactsources.md) | - - - -### LabProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| labStorageType | enum | No | Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. - Standard or Premium | -| premiumDataDisks | enum | No | 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. - Disabled or Enabled | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/artifactsources.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/artifactsources.md deleted file mode 100644 index 298ce8a..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/artifactsources.md +++ /dev/null @@ -1,58 +0,0 @@ -# Microsoft.DevTestLab/labs/artifactsources template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/artifactsources resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/artifactsources", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "displayName": "string", - "uri": "string", - "sourceType": "string", - "folderPath": "string", - "armTemplateFolderPath": "string", - "branchRef": "string", - "securityToken": "string", - "status": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/artifactsources object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/artifactsources | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [ArtifactSourceProperties object](#ArtifactSourceProperties) | - - - -### ArtifactSourceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| displayName | string | No | The artifact source's display name. | -| uri | string | No | The artifact source's URI. | -| sourceType | enum | No | The artifact source's type. - VsoGit or GitHub | -| folderPath | string | No | The folder containing artifacts. | -| armTemplateFolderPath | string | No | The folder containing Azure Resource Manager templates. | -| branchRef | string | No | The artifact source's branch reference. | -| securityToken | string | No | The security token to authenticate to the artifact source. | -| status | enum | No | Indicates if the artifact source is enabled (values: Enabled, Disabled). - Enabled or Disabled | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/costs.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/costs.md deleted file mode 100644 index dd02829..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/costs.md +++ /dev/null @@ -1,99 +0,0 @@ -# Microsoft.DevTestLab/labs/costs template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/costs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/costs", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "targetCost": { - "status": "string", - "target": "integer", - "costThresholds": [ - { - "thresholdId": "string", - "percentageThreshold": { - "thresholdValue": "number" - }, - "displayOnChart": "string", - "sendNotificationWhenExceeded": "string", - "notificationSent": "string" - } - ], - "cycleStartDateTime": "string", - "cycleEndDateTime": "string", - "cycleType": "string" - }, - "currencyCode": "string", - "startDateTime": "string", - "endDateTime": "string", - "createdDate": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/costs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/costs | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [LabCostProperties object](#LabCostProperties) | - - - -### LabCostProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| targetCost | object | No | The target cost properties - [TargetCostProperties object](#TargetCostProperties) | -| currencyCode | string | No | The currency code of the cost. | -| startDateTime | string | No | The start time of the cost data. | -| endDateTime | string | No | The end time of the cost data. | -| createdDate | string | No | The creation date of the cost. | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### TargetCostProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | Target cost status. - Enabled or Disabled | -| target | integer | No | Lab target cost | -| costThresholds | array | No | Cost thresholds. - [CostThresholdProperties object](#CostThresholdProperties) | -| cycleStartDateTime | string | No | Reporting cycle start date. | -| cycleEndDateTime | string | No | Reporting cycle end date. | -| cycleType | enum | No | Reporting cycle type. - CalendarMonth or Custom | - - - -### CostThresholdProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thresholdId | string | No | The ID of the cost threshold item. | -| percentageThreshold | object | No | The value of the percentage cost threshold. - [PercentageCostThresholdProperties object](#PercentageCostThresholdProperties) | -| displayOnChart | enum | No | Indicates whether this threshold will be displayed on cost charts. - Enabled or Disabled | -| sendNotificationWhenExceeded | enum | No | Indicates whether notifications will be sent when this threshold is exceeded. - Enabled or Disabled | -| notificationSent | string | No | Indicates the datetime when notifications were last sent for this threshold. | - - - -### PercentageCostThresholdProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thresholdValue | number | No | The cost threshold value. | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/customimages.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/customimages.md deleted file mode 100644 index 8b3f668..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/customimages.md +++ /dev/null @@ -1,96 +0,0 @@ -# Microsoft.DevTestLab/labs/customimages template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/customimages resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/customimages", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "vm": { - "sourceVmId": "string", - "windowsOsInfo": { - "windowsOsState": "string" - }, - "linuxOsInfo": { - "linuxOsState": "string" - } - }, - "vhd": { - "imageName": "string", - "sysPrep": "boolean", - "osType": "string" - }, - "description": "string", - "author": "string", - "managedImageId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/customimages object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/customimages | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [CustomImageProperties object](#CustomImageProperties) | - - - -### CustomImageProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vm | object | No | The virtual machine from which the image is to be created. - [CustomImagePropertiesFromVm object](#CustomImagePropertiesFromVm) | -| vhd | object | No | The VHD from which the image is to be created. - [CustomImagePropertiesCustom object](#CustomImagePropertiesCustom) | -| description | string | No | The description of the custom image. | -| author | string | No | The author of the custom image. | -| managedImageId | string | No | The Managed Image Id backing the custom image. | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### CustomImagePropertiesFromVm object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sourceVmId | string | No | The source vm identifier. | -| windowsOsInfo | object | No | The Windows OS information of the VM. - [WindowsOsInfo object](#WindowsOsInfo) | -| linuxOsInfo | object | No | The Linux OS information of the VM. - [LinuxOsInfo object](#LinuxOsInfo) | - - - -### CustomImagePropertiesCustom object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| imageName | string | No | The image name. | -| sysPrep | boolean | No | Indicates whether sysprep has been run on the VHD. | -| osType | enum | Yes | The OS type of the custom image (i.e. Windows, Linux). - Windows, Linux, None | - - - -### WindowsOsInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| windowsOsState | enum | No | The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). - NonSysprepped, SysprepRequested, SysprepApplied | - - - -### LinuxOsInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linuxOsState | enum | No | The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). - NonDeprovisioned, DeprovisionRequested, DeprovisionApplied | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/formulas.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/formulas.md deleted file mode 100644 index e895d59..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/formulas.md +++ /dev/null @@ -1,458 +0,0 @@ -# Microsoft.DevTestLab/labs/formulas template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/formulas resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/formulas", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "description": "string", - "author": "string", - "osType": "string", - "formulaContent": { - "properties": { - "bulkCreationParameters": { - "instanceCount": "integer" - }, - "notes": "string", - "ownerObjectId": "string", - "ownerUserPrincipalName": "string", - "createdByUserId": "string", - "createdByUser": "string", - "createdDate": "string", - "customImageId": "string", - "osType": "string", - "size": "string", - "userName": "string", - "password": "string", - "sshKey": "string", - "isAuthenticationWithSshKey": "boolean", - "fqdn": "string", - "labSubnetName": "string", - "labVirtualNetworkId": "string", - "disallowPublicIpAddress": "boolean", - "artifacts": [ - { - "artifactId": "string", - "parameters": [ - { - "name": "string", - "value": "string" - } - ], - "status": "string", - "deploymentStatusMessage": "string", - "vmExtensionStatusMessage": "string", - "installTime": "string" - } - ], - "artifactDeploymentStatus": { - "deploymentStatus": "string", - "artifactsApplied": "integer", - "totalArtifacts": "integer" - }, - "galleryImageReference": { - "offer": "string", - "publisher": "string", - "sku": "string", - "osType": "string", - "version": "string" - }, - "computeVm": { - "statuses": [ - { - "code": "string", - "displayStatus": "string", - "message": "string" - } - ], - "osType": "string", - "vmSize": "string", - "networkInterfaceId": "string", - "osDiskId": "string", - "dataDiskIds": [ - "string" - ], - "dataDisks": [ - { - "name": "string", - "diskUri": "string", - "managedDiskId": "string", - "diskSizeGiB": "integer" - } - ] - }, - "networkInterface": { - "virtualNetworkId": "string", - "subnetId": "string", - "publicIpAddressId": "string", - "publicIpAddress": "string", - "privateIpAddress": "string", - "dnsName": "string", - "rdpAuthority": "string", - "sshAuthority": "string", - "sharedPublicIpAddressConfiguration": { - "inboundNatRules": [ - { - "transportProtocol": "string", - "frontendPort": "integer", - "backendPort": "integer" - } - ] - } - }, - "applicableSchedule": { - "location": "string", - "tags": {}, - "properties": { - "labVmsShutdown": { - "location": "string", - "tags": {}, - "properties": { - "status": "string", - "taskType": "string", - "weeklyRecurrence": { - "weekdays": [ - "string" - ], - "time": "string" - }, - "dailyRecurrence": { - "time": "string" - }, - "hourlyRecurrence": { - "minute": "integer" - }, - "timeZoneId": "string", - "notificationSettings": { - "status": "string", - "timeInMinutes": "integer", - "webhookUrl": "string" - }, - "targetResourceId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } - }, - "labVmsStartup": { - "location": "string", - "tags": {}, - "properties": { - "status": "string", - "taskType": "string", - "weeklyRecurrence": { - "weekdays": [ - "string" - ], - "time": "string" - }, - "dailyRecurrence": { - "time": "string" - }, - "hourlyRecurrence": { - "minute": "integer" - }, - "timeZoneId": "string", - "notificationSettings": { - "status": "string", - "timeInMinutes": "integer", - "webhookUrl": "string" - }, - "targetResourceId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } - } - } - }, - "expirationDate": "string", - "allowClaim": "boolean", - "storageType": "string", - "virtualMachineCreationSource": "string", - "environmentId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - }, - "name": "string", - "location": "string", - "tags": {} - }, - "vm": { - "labVmId": "string" - }, - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/formulas object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/formulas | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [FormulaProperties object](#FormulaProperties) | - - - -### FormulaProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | The description of the formula. | -| author | string | No | The author of the formula. | -| osType | string | No | The OS type of the formula. | -| formulaContent | object | No | The content of the formula. - [LabVirtualMachineCreationParameter object](#LabVirtualMachineCreationParameter) | -| vm | object | No | Information about a VM from which a formula is to be created. - [FormulaPropertiesFromVm object](#FormulaPropertiesFromVm) | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### LabVirtualMachineCreationParameter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| properties | object | No | The properties of the resource. - [LabVirtualMachineCreationParameterProperties object](#LabVirtualMachineCreationParameterProperties) | -| name | string | No | The name of the virtual machine or environment | -| location | string | No | The location of the new virtual machine or environment | -| tags | object | No | The tags of the resource. | - - - -### FormulaPropertiesFromVm object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| labVmId | string | No | The identifier of the VM from which a formula is to be created. | - - - -### LabVirtualMachineCreationParameterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bulkCreationParameters | object | No | The number of virtual machine instances to create. - [BulkCreationParameters object](#BulkCreationParameters) | -| notes | string | No | The notes of the virtual machine. | -| ownerObjectId | string | No | The object identifier of the owner of the virtual machine. | -| ownerUserPrincipalName | string | No | The user principal name of the virtual machine owner. | -| createdByUserId | string | No | The object identifier of the creator of the virtual machine. | -| createdByUser | string | No | The email address of creator of the virtual machine. | -| createdDate | string | No | The creation date of the virtual machine. | -| customImageId | string | No | The custom image identifier of the virtual machine. | -| osType | string | No | The OS type of the virtual machine. | -| size | string | No | The size of the virtual machine. | -| userName | string | No | The user name of the virtual machine. | -| password | string | No | The password of the virtual machine administrator. | -| sshKey | string | No | The SSH key of the virtual machine administrator. | -| isAuthenticationWithSshKey | boolean | No | Indicates whether this virtual machine uses an SSH key for authentication. | -| fqdn | string | No | The fully-qualified domain name of the virtual machine. | -| labSubnetName | string | No | The lab subnet name of the virtual machine. | -| labVirtualNetworkId | string | No | The lab virtual network identifier of the virtual machine. | -| disallowPublicIpAddress | boolean | No | Indicates whether the virtual machine is to be created without a public IP address. | -| artifacts | array | No | The artifacts to be installed on the virtual machine. - [ArtifactInstallProperties object](#ArtifactInstallProperties) | -| artifactDeploymentStatus | object | No | The artifact deployment status for the virtual machine. - [ArtifactDeploymentStatusProperties object](#ArtifactDeploymentStatusProperties) | -| galleryImageReference | object | No | The Microsoft Azure Marketplace image reference of the virtual machine. - [GalleryImageReference object](#GalleryImageReference) | -| computeVm | object | No | The compute virtual machine properties. - [ComputeVmProperties object](#ComputeVmProperties) | -| networkInterface | object | No | The network interface properties. - [NetworkInterfaceProperties object](#NetworkInterfaceProperties) | -| applicableSchedule | object | No | The applicable schedule for the virtual machine. - [ApplicableSchedule object](#ApplicableSchedule) | -| expirationDate | string | No | The expiration date for VM. | -| allowClaim | boolean | No | Indicates whether another user can take ownership of the virtual machine | -| storageType | string | No | Storage type to use for virtual machine (i.e. Standard, Premium). | -| virtualMachineCreationSource | enum | No | Tells source of creation of lab virtual machine. Output property only. - FromCustomImage or FromGalleryImage | -| environmentId | string | No | The resource ID of the environment that contains this virtual machine, if any. | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### BulkCreationParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| instanceCount | integer | No | The number of virtual machine instances to create. | - - - -### ArtifactInstallProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| artifactId | string | No | The artifact's identifier. | -| parameters | array | No | The parameters of the artifact. - [ArtifactParameterProperties object](#ArtifactParameterProperties) | -| status | string | No | The status of the artifact. | -| deploymentStatusMessage | string | No | The status message from the deployment. | -| vmExtensionStatusMessage | string | No | The status message from the virtual machine extension. | -| installTime | string | No | The time that the artifact starts to install on the virtual machine. | - - - -### ArtifactDeploymentStatusProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| deploymentStatus | string | No | The deployment status of the artifact. | -| artifactsApplied | integer | No | The total count of the artifacts that were successfully applied. | -| totalArtifacts | integer | No | The total count of the artifacts that were tentatively applied. | - - - -### GalleryImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| offer | string | No | The offer of the gallery image. | -| publisher | string | No | The publisher of the gallery image. | -| sku | string | No | The SKU of the gallery image. | -| osType | string | No | The OS type of the gallery image. | -| version | string | No | The version of the gallery image. | - - - -### ComputeVmProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| statuses | array | No | Gets the statuses of the virtual machine. - [ComputeVmInstanceViewStatus object](#ComputeVmInstanceViewStatus) | -| osType | string | No | Gets the OS type of the virtual machine. | -| vmSize | string | No | Gets the size of the virtual machine. | -| networkInterfaceId | string | No | Gets the network interface ID of the virtual machine. | -| osDiskId | string | No | Gets OS disk blob uri for the virtual machine. | -| dataDiskIds | array | No | Gets data disks blob uri for the virtual machine. - string | -| dataDisks | array | No | Gets all data disks attached to the virtual machine. - [ComputeDataDisk object](#ComputeDataDisk) | - - - -### NetworkInterfaceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualNetworkId | string | No | The resource ID of the virtual network. | -| subnetId | string | No | The resource ID of the sub net. | -| publicIpAddressId | string | No | The resource ID of the public IP address. | -| publicIpAddress | string | No | The public IP address. | -| privateIpAddress | string | No | The private IP address. | -| dnsName | string | No | The DNS name. | -| rdpAuthority | string | No | 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 | No | The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. | -| sharedPublicIpAddressConfiguration | object | No | The configuration for sharing a public IP address across multiple virtual machines. - [SharedPublicIpAddressConfiguration object](#SharedPublicIpAddressConfiguration) | - - - -### ApplicableSchedule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [ApplicableScheduleProperties object](#ApplicableScheduleProperties) | - - - -### ArtifactParameterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the artifact parameter. | -| value | string | No | The value of the artifact parameter. | - - - -### ComputeVmInstanceViewStatus object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| code | string | No | Gets the status Code. | -| displayStatus | string | No | Gets the short localizable label for the status. | -| message | string | No | Gets the message associated with the status. | - - - -### ComputeDataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets data disk name. | -| diskUri | string | No | When backed by a blob, the URI of underlying blob. | -| managedDiskId | string | No | When backed by managed disk, this is the ID of the compute disk resource. | -| diskSizeGiB | integer | No | Gets data disk size in GiB. | - - - -### SharedPublicIpAddressConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| inboundNatRules | array | No | The incoming NAT rules - [InboundNatRule object](#InboundNatRule) | - - - -### ApplicableScheduleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| labVmsShutdown | object | No | The auto-shutdown schedule, if one has been set at the lab or lab resource level. - [Schedule object](#Schedule) | -| labVmsStartup | object | No | The auto-startup schedule, if one has been set at the lab or lab resource level. - [Schedule object](#Schedule) | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| transportProtocol | enum | No | The transport protocol for the endpoint. - Tcp or Udp | -| frontendPort | integer | No | The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. | -| backendPort | integer | No | The port to which the external traffic will be redirected. | - - - -### Schedule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [ScheduleProperties object](#ScheduleProperties) | - - - -### ScheduleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | The status of the schedule (i.e. Enabled, Disabled). - Enabled or Disabled | -| taskType | string | No | The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). | -| weeklyRecurrence | object | No | If the schedule will occur only some days of the week, specify the weekly recurrence. - [WeekDetails object](#WeekDetails) | -| dailyRecurrence | object | No | If the schedule will occur once each day of the week, specify the daily recurrence. - [DayDetails object](#DayDetails) | -| hourlyRecurrence | object | No | If the schedule will occur multiple times a day, specify the hourly recurrence. - [HourDetails object](#HourDetails) | -| timeZoneId | string | No | The time zone ID (e.g. Pacific Standard time). | -| notificationSettings | object | No | Notification settings. - [NotificationSettings object](#NotificationSettings) | -| targetResourceId | string | No | The resource ID to which the schedule belongs | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### WeekDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| weekdays | array | No | The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). - string | -| time | string | No | The time of the day the schedule will occur. | - - - -### DayDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| time | string | No | The time of day the schedule will occur. | - - - -### HourDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| minute | integer | No | Minutes of the hour the schedule will run. | - - - -### NotificationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | If notifications are enabled for this schedule (i.e. Enabled, Disabled). - Disabled or Enabled | -| timeInMinutes | integer | No | Time in minutes before event at which notification will be sent. | -| webhookUrl | string | No | The webhook URL to which the notification will be sent. | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/notificationchannels.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/notificationchannels.md deleted file mode 100644 index 8c8c611..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/notificationchannels.md +++ /dev/null @@ -1,59 +0,0 @@ -# Microsoft.DevTestLab/labs/notificationchannels template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/notificationchannels resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/notificationchannels", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "webHookUrl": "string", - "description": "string", - "events": [ - { - "eventName": "string" - } - ], - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/notificationchannels object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/notificationchannels | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [NotificationChannelProperties object](#NotificationChannelProperties) | - - - -### NotificationChannelProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| webHookUrl | string | No | The webhook URL to send notifications to. | -| description | string | No | Description of notification. | -| events | array | No | The list of event for which this notification is enabled. - [Event object](#Event) | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### Event object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| eventName | enum | No | The event type for which this notification is enabled (i.e. AutoShutdown, Cost). - AutoShutdown or Cost | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/policysets/policies.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/policysets/policies.md deleted file mode 100644 index c42db23..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/policysets/policies.md +++ /dev/null @@ -1,54 +0,0 @@ -# Microsoft.DevTestLab/labs/policysets/policies template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/policysets/policies resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/policysets/policies", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "description": "string", - "status": "string", - "factName": "string", - "factData": "string", - "threshold": "string", - "evaluatorType": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/policysets/policies object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/policysets/policies | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [PolicyProperties object](#PolicyProperties) | - - - -### PolicyProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | The description of the policy. | -| status | enum | No | The status of the policy. - Enabled or Disabled | -| factName | enum | No | The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. - UserOwnedLabVmCount, UserOwnedLabPremiumVmCount, LabVmCount, LabPremiumVmCount, LabVmSize, GalleryImage, UserOwnedLabVmCountInSubnet, LabTargetCost | -| factData | string | No | The fact data of the policy. | -| threshold | string | No | The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). | -| evaluatorType | enum | No | The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). - AllowedValuesPolicy or MaxValuePolicy | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/schedules.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/schedules.md deleted file mode 100644 index db4d733..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/schedules.md +++ /dev/null @@ -1,102 +0,0 @@ -# Microsoft.DevTestLab/labs/schedules template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/schedules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/schedules", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "status": "string", - "taskType": "string", - "weeklyRecurrence": { - "weekdays": [ - "string" - ], - "time": "string" - }, - "dailyRecurrence": { - "time": "string" - }, - "hourlyRecurrence": { - "minute": "integer" - }, - "timeZoneId": "string", - "notificationSettings": { - "status": "string", - "timeInMinutes": "integer", - "webhookUrl": "string" - }, - "targetResourceId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/schedules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/schedules | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [ScheduleProperties object](#ScheduleProperties) | - - - -### ScheduleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | The status of the schedule (i.e. Enabled, Disabled). - Enabled or Disabled | -| taskType | string | No | The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). | -| weeklyRecurrence | object | No | If the schedule will occur only some days of the week, specify the weekly recurrence. - [WeekDetails object](#WeekDetails) | -| dailyRecurrence | object | No | If the schedule will occur once each day of the week, specify the daily recurrence. - [DayDetails object](#DayDetails) | -| hourlyRecurrence | object | No | If the schedule will occur multiple times a day, specify the hourly recurrence. - [HourDetails object](#HourDetails) | -| timeZoneId | string | No | The time zone ID (e.g. Pacific Standard time). | -| notificationSettings | object | No | Notification settings. - [NotificationSettings object](#NotificationSettings) | -| targetResourceId | string | No | The resource ID to which the schedule belongs | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### WeekDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| weekdays | array | No | The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). - string | -| time | string | No | The time of the day the schedule will occur. | - - - -### DayDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| time | string | No | The time of day the schedule will occur. | - - - -### HourDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| minute | integer | No | Minutes of the hour the schedule will run. | - - - -### NotificationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | If notifications are enabled for this schedule (i.e. Enabled, Disabled). - Disabled or Enabled | -| timeInMinutes | integer | No | Time in minutes before event at which notification will be sent. | -| webhookUrl | string | No | The webhook URL to which the notification will be sent. | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/servicerunners.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/servicerunners.md deleted file mode 100644 index 438d396..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/servicerunners.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.DevTestLab/labs/servicerunners template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/servicerunners resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/servicerunners", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "identity": { - "type": "string", - "principalId": "string", - "tenantId": "string", - "clientSecretUrl": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/servicerunners object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/servicerunners | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| identity | object | No | The identity of the resource. - [IdentityProperties object](#IdentityProperties) | - - - -### IdentityProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | string | No | Managed identity. | -| principalId | string | No | The principal id of resource identity. | -| tenantId | string | No | The tenant identifier of resource. | -| clientSecretUrl | string | No | The client secret URL of the identity. | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users.md deleted file mode 100644 index dd518f0..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users.md +++ /dev/null @@ -1,76 +0,0 @@ -# Microsoft.DevTestLab/labs/users template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/users resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/users", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "identity": { - "principalName": "string", - "principalId": "string", - "tenantId": "string", - "objectId": "string", - "appId": "string" - }, - "secretStore": { - "keyVaultUri": "string", - "keyVaultId": "string" - }, - "provisioningState": "string", - "uniqueIdentifier": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/users object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/users | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [UserProperties object](#UserProperties) | -| resources | array | No | [secrets](./users/secrets.md) [environments](./users/environments.md) [disks](./users/disks.md) | - - - -### UserProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| identity | object | No | The identity of the user. - [UserIdentity object](#UserIdentity) | -| secretStore | object | No | The secret store of the user. - [UserSecretStore object](#UserSecretStore) | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### UserIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| principalName | string | No | Set to the principal name / UPN of the client JWT making the request. | -| principalId | string | No | Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. | -| tenantId | string | No | Set to the tenant ID of the client JWT making the request. | -| objectId | string | No | 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. | -| appId | string | No | Set to the app Id of the client JWT making the request. | - - - -### UserSecretStore object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyVaultUri | string | No | The URI of the user's Key vault. | -| keyVaultId | string | No | The ID of the user's Key vault. | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/disks.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/disks.md deleted file mode 100644 index 243091f..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/disks.md +++ /dev/null @@ -1,56 +0,0 @@ -# Microsoft.DevTestLab/labs/users/disks template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/users/disks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/users/disks", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "diskType": "string", - "diskSizeGiB": "integer", - "leasedByLabVmId": "string", - "diskBlobName": "string", - "diskUri": "string", - "hostCaching": "string", - "managedDiskId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/users/disks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/users/disks | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [DiskProperties object](#DiskProperties) | - - - -### DiskProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| diskType | enum | No | The storage type for the disk (i.e. Standard, Premium). - Standard or Premium | -| diskSizeGiB | integer | No | The size of the disk in GibiBytes. | -| leasedByLabVmId | string | No | The resource ID of the VM to which this disk is leased. | -| diskBlobName | string | No | When backed by a blob, the name of the VHD blob without extension. | -| diskUri | string | No | When backed by a blob, the URI of underlying blob. | -| hostCaching | string | No | The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). | -| managedDiskId | string | No | When backed by managed disk, this is the ID of the compute disk resource. | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/environments.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/environments.md deleted file mode 100644 index 33bb863..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/environments.md +++ /dev/null @@ -1,70 +0,0 @@ -# Microsoft.DevTestLab/labs/users/environments template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/users/environments resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/users/environments", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "deploymentProperties": { - "armTemplateId": "string", - "parameters": [ - { - "name": "string", - "value": "string" - } - ] - }, - "armTemplateDisplayName": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/users/environments object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/users/environments | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [EnvironmentProperties object](#EnvironmentProperties) | - - - -### EnvironmentProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| deploymentProperties | object | No | The deployment properties of the environment. - [EnvironmentDeploymentProperties object](#EnvironmentDeploymentProperties) | -| armTemplateDisplayName | string | No | The display name of the Azure Resource Manager template that produced the environment. | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### EnvironmentDeploymentProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| armTemplateId | string | No | The Azure Resource Manager template's identifier. | -| parameters | array | No | The parameters of the Azure Resource Manager template. - [ArmTemplateParameterProperties object](#ArmTemplateParameterProperties) | - - - -### ArmTemplateParameterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the template parameter. | -| value | string | No | The value of the template parameter. | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/secrets.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/secrets.md deleted file mode 100644 index 503ccfe..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/users/secrets.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.DevTestLab/labs/users/secrets template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/users/secrets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/users/secrets", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "value": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/users/secrets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/users/secrets | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [SecretProperties object](#SecretProperties) | - - - -### SecretProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | string | No | The value of the secret for secret creation. | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualmachines.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualmachines.md deleted file mode 100644 index d108285..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualmachines.md +++ /dev/null @@ -1,404 +0,0 @@ -# Microsoft.DevTestLab/labs/virtualmachines template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/virtualmachines resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/virtualmachines", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "notes": "string", - "ownerObjectId": "string", - "ownerUserPrincipalName": "string", - "createdByUserId": "string", - "createdByUser": "string", - "createdDate": "string", - "customImageId": "string", - "osType": "string", - "size": "string", - "userName": "string", - "password": "string", - "sshKey": "string", - "isAuthenticationWithSshKey": "boolean", - "fqdn": "string", - "labSubnetName": "string", - "labVirtualNetworkId": "string", - "disallowPublicIpAddress": "boolean", - "artifacts": [ - { - "artifactId": "string", - "parameters": [ - { - "name": "string", - "value": "string" - } - ], - "status": "string", - "deploymentStatusMessage": "string", - "vmExtensionStatusMessage": "string", - "installTime": "string" - } - ], - "artifactDeploymentStatus": { - "deploymentStatus": "string", - "artifactsApplied": "integer", - "totalArtifacts": "integer" - }, - "galleryImageReference": { - "offer": "string", - "publisher": "string", - "sku": "string", - "osType": "string", - "version": "string" - }, - "computeVm": { - "statuses": [ - { - "code": "string", - "displayStatus": "string", - "message": "string" - } - ], - "osType": "string", - "vmSize": "string", - "networkInterfaceId": "string", - "osDiskId": "string", - "dataDiskIds": [ - "string" - ], - "dataDisks": [ - { - "name": "string", - "diskUri": "string", - "managedDiskId": "string", - "diskSizeGiB": "integer" - } - ] - }, - "networkInterface": { - "virtualNetworkId": "string", - "subnetId": "string", - "publicIpAddressId": "string", - "publicIpAddress": "string", - "privateIpAddress": "string", - "dnsName": "string", - "rdpAuthority": "string", - "sshAuthority": "string", - "sharedPublicIpAddressConfiguration": { - "inboundNatRules": [ - { - "transportProtocol": "string", - "frontendPort": "integer", - "backendPort": "integer" - } - ] - } - }, - "applicableSchedule": { - "location": "string", - "tags": {}, - "properties": { - "labVmsShutdown": { - "location": "string", - "tags": {}, - "properties": { - "status": "string", - "taskType": "string", - "weeklyRecurrence": { - "weekdays": [ - "string" - ], - "time": "string" - }, - "dailyRecurrence": { - "time": "string" - }, - "hourlyRecurrence": { - "minute": "integer" - }, - "timeZoneId": "string", - "notificationSettings": { - "status": "string", - "timeInMinutes": "integer", - "webhookUrl": "string" - }, - "targetResourceId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } - }, - "labVmsStartup": { - "location": "string", - "tags": {}, - "properties": { - "status": "string", - "taskType": "string", - "weeklyRecurrence": { - "weekdays": [ - "string" - ], - "time": "string" - }, - "dailyRecurrence": { - "time": "string" - }, - "hourlyRecurrence": { - "minute": "integer" - }, - "timeZoneId": "string", - "notificationSettings": { - "status": "string", - "timeInMinutes": "integer", - "webhookUrl": "string" - }, - "targetResourceId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } - } - } - }, - "expirationDate": "string", - "allowClaim": "boolean", - "storageType": "string", - "virtualMachineCreationSource": "string", - "environmentId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/virtualmachines object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/virtualmachines | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [LabVirtualMachineProperties object](#LabVirtualMachineProperties) | -| resources | array | No | [schedules](./virtualmachines/schedules.md) | - - - -### LabVirtualMachineProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| notes | string | No | The notes of the virtual machine. | -| ownerObjectId | string | No | The object identifier of the owner of the virtual machine. | -| ownerUserPrincipalName | string | No | The user principal name of the virtual machine owner. | -| createdByUserId | string | No | The object identifier of the creator of the virtual machine. | -| createdByUser | string | No | The email address of creator of the virtual machine. | -| createdDate | string | No | The creation date of the virtual machine. | -| customImageId | string | No | The custom image identifier of the virtual machine. | -| osType | string | No | The OS type of the virtual machine. | -| size | string | No | The size of the virtual machine. | -| userName | string | No | The user name of the virtual machine. | -| password | string | No | The password of the virtual machine administrator. | -| sshKey | string | No | The SSH key of the virtual machine administrator. | -| isAuthenticationWithSshKey | boolean | No | Indicates whether this virtual machine uses an SSH key for authentication. | -| fqdn | string | No | The fully-qualified domain name of the virtual machine. | -| labSubnetName | string | No | The lab subnet name of the virtual machine. | -| labVirtualNetworkId | string | No | The lab virtual network identifier of the virtual machine. | -| disallowPublicIpAddress | boolean | No | Indicates whether the virtual machine is to be created without a public IP address. | -| artifacts | array | No | The artifacts to be installed on the virtual machine. - [ArtifactInstallProperties object](#ArtifactInstallProperties) | -| artifactDeploymentStatus | object | No | The artifact deployment status for the virtual machine. - [ArtifactDeploymentStatusProperties object](#ArtifactDeploymentStatusProperties) | -| galleryImageReference | object | No | The Microsoft Azure Marketplace image reference of the virtual machine. - [GalleryImageReference object](#GalleryImageReference) | -| computeVm | object | No | The compute virtual machine properties. - [ComputeVmProperties object](#ComputeVmProperties) | -| networkInterface | object | No | The network interface properties. - [NetworkInterfaceProperties object](#NetworkInterfaceProperties) | -| applicableSchedule | object | No | The applicable schedule for the virtual machine. - [ApplicableSchedule object](#ApplicableSchedule) | -| expirationDate | string | No | The expiration date for VM. | -| allowClaim | boolean | No | Indicates whether another user can take ownership of the virtual machine | -| storageType | string | No | Storage type to use for virtual machine (i.e. Standard, Premium). | -| virtualMachineCreationSource | enum | No | Tells source of creation of lab virtual machine. Output property only. - FromCustomImage or FromGalleryImage | -| environmentId | string | No | The resource ID of the environment that contains this virtual machine, if any. | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### ArtifactInstallProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| artifactId | string | No | The artifact's identifier. | -| parameters | array | No | The parameters of the artifact. - [ArtifactParameterProperties object](#ArtifactParameterProperties) | -| status | string | No | The status of the artifact. | -| deploymentStatusMessage | string | No | The status message from the deployment. | -| vmExtensionStatusMessage | string | No | The status message from the virtual machine extension. | -| installTime | string | No | The time that the artifact starts to install on the virtual machine. | - - - -### ArtifactDeploymentStatusProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| deploymentStatus | string | No | The deployment status of the artifact. | -| artifactsApplied | integer | No | The total count of the artifacts that were successfully applied. | -| totalArtifacts | integer | No | The total count of the artifacts that were tentatively applied. | - - - -### GalleryImageReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| offer | string | No | The offer of the gallery image. | -| publisher | string | No | The publisher of the gallery image. | -| sku | string | No | The SKU of the gallery image. | -| osType | string | No | The OS type of the gallery image. | -| version | string | No | The version of the gallery image. | - - - -### ComputeVmProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| statuses | array | No | Gets the statuses of the virtual machine. - [ComputeVmInstanceViewStatus object](#ComputeVmInstanceViewStatus) | -| osType | string | No | Gets the OS type of the virtual machine. | -| vmSize | string | No | Gets the size of the virtual machine. | -| networkInterfaceId | string | No | Gets the network interface ID of the virtual machine. | -| osDiskId | string | No | Gets OS disk blob uri for the virtual machine. | -| dataDiskIds | array | No | Gets data disks blob uri for the virtual machine. - string | -| dataDisks | array | No | Gets all data disks attached to the virtual machine. - [ComputeDataDisk object](#ComputeDataDisk) | - - - -### NetworkInterfaceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualNetworkId | string | No | The resource ID of the virtual network. | -| subnetId | string | No | The resource ID of the sub net. | -| publicIpAddressId | string | No | The resource ID of the public IP address. | -| publicIpAddress | string | No | The public IP address. | -| privateIpAddress | string | No | The private IP address. | -| dnsName | string | No | The DNS name. | -| rdpAuthority | string | No | 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 | No | The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. | -| sharedPublicIpAddressConfiguration | object | No | The configuration for sharing a public IP address across multiple virtual machines. - [SharedPublicIpAddressConfiguration object](#SharedPublicIpAddressConfiguration) | - - - -### ApplicableSchedule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [ApplicableScheduleProperties object](#ApplicableScheduleProperties) | - - - -### ArtifactParameterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the artifact parameter. | -| value | string | No | The value of the artifact parameter. | - - - -### ComputeVmInstanceViewStatus object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| code | string | No | Gets the status Code. | -| displayStatus | string | No | Gets the short localizable label for the status. | -| message | string | No | Gets the message associated with the status. | - - - -### ComputeDataDisk object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets data disk name. | -| diskUri | string | No | When backed by a blob, the URI of underlying blob. | -| managedDiskId | string | No | When backed by managed disk, this is the ID of the compute disk resource. | -| diskSizeGiB | integer | No | Gets data disk size in GiB. | - - - -### SharedPublicIpAddressConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| inboundNatRules | array | No | The incoming NAT rules - [InboundNatRule object](#InboundNatRule) | - - - -### ApplicableScheduleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| labVmsShutdown | object | No | The auto-shutdown schedule, if one has been set at the lab or lab resource level. - [Schedule object](#Schedule) | -| labVmsStartup | object | No | The auto-startup schedule, if one has been set at the lab or lab resource level. - [Schedule object](#Schedule) | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| transportProtocol | enum | No | The transport protocol for the endpoint. - Tcp or Udp | -| frontendPort | integer | No | The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. | -| backendPort | integer | No | The port to which the external traffic will be redirected. | - - - -### Schedule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [ScheduleProperties object](#ScheduleProperties) | - - - -### ScheduleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | The status of the schedule (i.e. Enabled, Disabled). - Enabled or Disabled | -| taskType | string | No | The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). | -| weeklyRecurrence | object | No | If the schedule will occur only some days of the week, specify the weekly recurrence. - [WeekDetails object](#WeekDetails) | -| dailyRecurrence | object | No | If the schedule will occur once each day of the week, specify the daily recurrence. - [DayDetails object](#DayDetails) | -| hourlyRecurrence | object | No | If the schedule will occur multiple times a day, specify the hourly recurrence. - [HourDetails object](#HourDetails) | -| timeZoneId | string | No | The time zone ID (e.g. Pacific Standard time). | -| notificationSettings | object | No | Notification settings. - [NotificationSettings object](#NotificationSettings) | -| targetResourceId | string | No | The resource ID to which the schedule belongs | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### WeekDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| weekdays | array | No | The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). - string | -| time | string | No | The time of the day the schedule will occur. | - - - -### DayDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| time | string | No | The time of day the schedule will occur. | - - - -### HourDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| minute | integer | No | Minutes of the hour the schedule will run. | - - - -### NotificationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | If notifications are enabled for this schedule (i.e. Enabled, Disabled). - Disabled or Enabled | -| timeInMinutes | integer | No | Time in minutes before event at which notification will be sent. | -| webhookUrl | string | No | The webhook URL to which the notification will be sent. | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualmachines/schedules.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualmachines/schedules.md deleted file mode 100644 index c8fa304..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualmachines/schedules.md +++ /dev/null @@ -1,102 +0,0 @@ -# Microsoft.DevTestLab/labs/virtualmachines/schedules template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/virtualmachines/schedules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/virtualmachines/schedules", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "status": "string", - "taskType": "string", - "weeklyRecurrence": { - "weekdays": [ - "string" - ], - "time": "string" - }, - "dailyRecurrence": { - "time": "string" - }, - "hourlyRecurrence": { - "minute": "integer" - }, - "timeZoneId": "string", - "notificationSettings": { - "status": "string", - "timeInMinutes": "integer", - "webhookUrl": "string" - }, - "targetResourceId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/virtualmachines/schedules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/virtualmachines/schedules | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [ScheduleProperties object](#ScheduleProperties) | - - - -### ScheduleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | The status of the schedule (i.e. Enabled, Disabled). - Enabled or Disabled | -| taskType | string | No | The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). | -| weeklyRecurrence | object | No | If the schedule will occur only some days of the week, specify the weekly recurrence. - [WeekDetails object](#WeekDetails) | -| dailyRecurrence | object | No | If the schedule will occur once each day of the week, specify the daily recurrence. - [DayDetails object](#DayDetails) | -| hourlyRecurrence | object | No | If the schedule will occur multiple times a day, specify the hourly recurrence. - [HourDetails object](#HourDetails) | -| timeZoneId | string | No | The time zone ID (e.g. Pacific Standard time). | -| notificationSettings | object | No | Notification settings. - [NotificationSettings object](#NotificationSettings) | -| targetResourceId | string | No | The resource ID to which the schedule belongs | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### WeekDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| weekdays | array | No | The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). - string | -| time | string | No | The time of the day the schedule will occur. | - - - -### DayDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| time | string | No | The time of day the schedule will occur. | - - - -### HourDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| minute | integer | No | Minutes of the hour the schedule will run. | - - - -### NotificationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | If notifications are enabled for this schedule (i.e. Enabled, Disabled). - Disabled or Enabled | -| timeInMinutes | integer | No | Time in minutes before event at which notification will be sent. | -| webhookUrl | string | No | The webhook URL to which the notification will be sent. | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualnetworks.md b/test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualnetworks.md deleted file mode 100644 index 37cdaa1..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/labs/virtualnetworks.md +++ /dev/null @@ -1,123 +0,0 @@ -# Microsoft.DevTestLab/labs/virtualnetworks template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/labs/virtualnetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/labs/virtualnetworks", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "allowedSubnets": [ - { - "resourceId": "string", - "labSubnetName": "string", - "allowPublicIp": "string" - } - ], - "description": "string", - "externalProviderResourceId": "string", - "externalSubnets": [ - { - "id": "string", - "name": "string" - } - ], - "subnetOverrides": [ - { - "resourceId": "string", - "labSubnetName": "string", - "useInVmCreationPermission": "string", - "usePublicIpAddressPermission": "string", - "sharedPublicIpAddressConfiguration": { - "allowedPorts": [ - { - "transportProtocol": "string", - "backendPort": "integer" - } - ] - }, - "virtualNetworkPoolName": "string" - } - ], - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/labs/virtualnetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/labs/virtualnetworks | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [VirtualNetworkProperties object](#VirtualNetworkProperties) | - - - -### VirtualNetworkProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowedSubnets | array | No | The allowed subnets of the virtual network. - [Subnet object](#Subnet) | -| description | string | No | The description of the virtual network. | -| externalProviderResourceId | string | No | The Microsoft.Network resource identifier of the virtual network. | -| externalSubnets | array | No | The external subnet properties. - [ExternalSubnet object](#ExternalSubnet) | -| subnetOverrides | array | No | The subnet overrides of the virtual network. - [SubnetOverride object](#SubnetOverride) | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| resourceId | string | No | The resource ID of the subnet. | -| labSubnetName | string | No | The name of the subnet as seen in the lab. | -| allowPublicIp | enum | No | The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). - Default, Deny, Allow | - - - -### ExternalSubnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Gets or sets the identifier. | -| name | string | No | Gets or sets the name. | - - - -### SubnetOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| resourceId | string | No | The resource ID of the subnet. | -| labSubnetName | string | No | The name given to the subnet within the lab. | -| useInVmCreationPermission | enum | No | Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). - Default, Deny, Allow | -| usePublicIpAddressPermission | enum | No | Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). - Default, Deny, Allow | -| sharedPublicIpAddressConfiguration | object | No | Properties that virtual machines on this subnet will share. - [SubnetSharedPublicIpAddressConfiguration object](#SubnetSharedPublicIpAddressConfiguration) | -| virtualNetworkPoolName | string | No | The virtual network pool associated with this subnet. | - - - -### SubnetSharedPublicIpAddressConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowedPorts | array | No | Backend ports that virtual machines on this subnet are allowed to expose - [Port object](#Port) | - - - -### Port object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| transportProtocol | enum | No | Protocol type of the port. - Tcp or Udp | -| backendPort | integer | No | Backend port of the target virtual machine. | - diff --git a/test/Resource/Expected/DevTestLabs/2016-05-15/schedules.md b/test/Resource/Expected/DevTestLabs/2016-05-15/schedules.md deleted file mode 100644 index 8521879..0000000 --- a/test/Resource/Expected/DevTestLabs/2016-05-15/schedules.md +++ /dev/null @@ -1,102 +0,0 @@ -# Microsoft.DevTestLab/schedules template reference -API Version: 2016-05-15 -## Template format - -To create a Microsoft.DevTestLab/schedules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DevTestLab/schedules", - "apiVersion": "2016-05-15", - "location": "string", - "tags": {}, - "properties": { - "status": "string", - "taskType": "string", - "weeklyRecurrence": { - "weekdays": [ - "string" - ], - "time": "string" - }, - "dailyRecurrence": { - "time": "string" - }, - "hourlyRecurrence": { - "minute": "integer" - }, - "timeZoneId": "string", - "notificationSettings": { - "status": "string", - "timeInMinutes": "integer", - "webhookUrl": "string" - }, - "targetResourceId": "string", - "provisioningState": "string", - "uniqueIdentifier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DevTestLab/schedules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DevTestLab/schedules | -| apiVersion | enum | Yes | 2016-05-15 | -| location | string | No | The location of the resource. | -| tags | object | No | The tags of the resource. | -| properties | object | Yes | The properties of the resource. - [ScheduleProperties object](#ScheduleProperties) | - - - -### ScheduleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | The status of the schedule (i.e. Enabled, Disabled). - Enabled or Disabled | -| taskType | string | No | The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). | -| weeklyRecurrence | object | No | If the schedule will occur only some days of the week, specify the weekly recurrence. - [WeekDetails object](#WeekDetails) | -| dailyRecurrence | object | No | If the schedule will occur once each day of the week, specify the daily recurrence. - [DayDetails object](#DayDetails) | -| hourlyRecurrence | object | No | If the schedule will occur multiple times a day, specify the hourly recurrence. - [HourDetails object](#HourDetails) | -| timeZoneId | string | No | The time zone ID (e.g. Pacific Standard time). | -| notificationSettings | object | No | Notification settings. - [NotificationSettings object](#NotificationSettings) | -| targetResourceId | string | No | The resource ID to which the schedule belongs | -| provisioningState | string | No | The provisioning status of the resource. | -| uniqueIdentifier | string | No | The unique immutable identifier of a resource (Guid). | - - - -### WeekDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| weekdays | array | No | The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). - string | -| time | string | No | The time of the day the schedule will occur. | - - - -### DayDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| time | string | No | The time of day the schedule will occur. | - - - -### HourDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| minute | integer | No | Minutes of the hour the schedule will run. | - - - -### NotificationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | If notifications are enabled for this schedule (i.e. Enabled, Disabled). - Disabled or Enabled | -| timeInMinutes | integer | No | Time in minutes before event at which notification will be sent. | -| webhookUrl | string | No | The webhook URL to which the notification will be sent. | - diff --git a/test/Resource/Expected/EventGrid/2017-06-15-preview/Microsoft.EventGrid.json b/test/Resource/Expected/EventGrid/2017-06-15-preview/Microsoft.EventGrid.json deleted file mode 100644 index c3968d8..0000000 --- a/test/Resource/Expected/EventGrid/2017-06-15-preview/Microsoft.EventGrid.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-06-15-preview/Microsoft.EventGrid.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.EventGrid", - "description": "Microsoft EventGrid Resource Types", - "resourceDefinitions": { - "topics": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.EventGrid/topics" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-15-preview" - ] - }, - "location": { - "type": "string", - "description": "Location of the resource" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tags of the resource" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/TopicProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the topic" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.EventGrid/topics" - } - }, - "definitions": { - "TopicProperties": { - "type": "object", - "properties": {}, - "description": "Properties of the Topic" - } - } -} diff --git a/test/Resource/Expected/EventGrid/2017-06-15-preview/eventSubscriptions.md b/test/Resource/Expected/EventGrid/2017-06-15-preview/eventSubscriptions.md deleted file mode 100644 index 2fc1700..0000000 --- a/test/Resource/Expected/EventGrid/2017-06-15-preview/eventSubscriptions.md +++ /dev/null @@ -1,84 +0,0 @@ -# Microsoft.EventGrid/eventSubscriptions template reference -API Version: 2017-06-15-preview -## Template format - -To create a Microsoft.EventGrid/eventSubscriptions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventGrid/eventSubscriptions", - "apiVersion": "2017-06-15-preview", - "properties": { - "destination": { - "endpointType": "WebHook", - "properties": { - "endpointUrl": "string" - } - }, - "filter": { - "subjectBeginsWith": "string", - "subjectEndsWith": "string", - "includedEventTypes": [ - "string" - ], - "isSubjectCaseSensitive": "boolean" - }, - "labels": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventGrid/eventSubscriptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.EventGrid/eventSubscriptions | -| apiVersion | enum | Yes | 2017-06-15-preview | -| properties | object | Yes | Properties of the event subscription - [EventSubscriptionProperties object](#EventSubscriptionProperties) | - - - -### EventSubscriptionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| destination | object | No | Information about the destination where events have to be delivered for the event subscription. - [EventSubscriptionDestination object](#EventSubscriptionDestination) | -| filter | object | No | Information about the filter for the event subscription. - [EventSubscriptionFilter object](#EventSubscriptionFilter) | -| labels | array | No | List of user defined labels. - string | - - - -### EventSubscriptionDestination object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| endpointType | enum | No | Type of the endpoint for the event subscription destination. - WebHook | -| properties | object | No | Properties of the event subscription destination - [EventSubscriptionDestinationProperties object](#EventSubscriptionDestinationProperties) | - - - -### EventSubscriptionFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subjectBeginsWith | string | No | 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 | No | An optional string to filter events for an event subscription based on a resource path suffix. -Wildcard characters are not supported in this path. | -| includedEventTypes | array | No | A list of applicable event types that need to be part of the event subscription. -If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list. - string | -| isSubjectCaseSensitive | boolean | No | Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter -should be compared in a case sensitive manner. | - - - -### EventSubscriptionDestinationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| endpointUrl | string | No | The URL that represents the endpoint of the destination of an event subscription. | - diff --git a/test/Resource/Expected/EventGrid/2017-06-15-preview/topics.md b/test/Resource/Expected/EventGrid/2017-06-15-preview/topics.md deleted file mode 100644 index 2a3be0d..0000000 --- a/test/Resource/Expected/EventGrid/2017-06-15-preview/topics.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.EventGrid/topics template reference -API Version: 2017-06-15-preview -## Template format - -To create a Microsoft.EventGrid/topics resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventGrid/topics", - "apiVersion": "2017-06-15-preview", - "location": "string", - "tags": {}, - "properties": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventGrid/topics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.EventGrid/topics | -| apiVersion | enum | Yes | 2017-06-15-preview | -| location | string | Yes | Location of the resource | -| tags | object | No | Tags of the resource | -| properties | object | Yes | Properties of the topic - [TopicProperties object](#TopicProperties) | - diff --git a/test/Resource/Expected/EventGrid/2017-09-15-preview/Microsoft.EventGrid.json b/test/Resource/Expected/EventGrid/2017-09-15-preview/Microsoft.EventGrid.json deleted file mode 100644 index 8970d11..0000000 --- a/test/Resource/Expected/EventGrid/2017-09-15-preview/Microsoft.EventGrid.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-09-15-preview/Microsoft.EventGrid.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.EventGrid", - "description": "Microsoft EventGrid Resource Types", - "resourceDefinitions": { - "topics": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.EventGrid/topics" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-15-preview" - ] - }, - "location": { - "type": "string", - "description": "Location of the resource" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tags of the resource" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/TopicProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the topic" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.EventGrid/topics" - } - }, - "definitions": { - "TopicProperties": { - "type": "object", - "properties": {}, - "description": "Properties of the Topic" - } - } -} diff --git a/test/Resource/Expected/EventGrid/2017-09-15-preview/eventSubscriptions.md b/test/Resource/Expected/EventGrid/2017-09-15-preview/eventSubscriptions.md deleted file mode 100644 index 33c0072..0000000 --- a/test/Resource/Expected/EventGrid/2017-09-15-preview/eventSubscriptions.md +++ /dev/null @@ -1,64 +0,0 @@ -# Microsoft.EventGrid/eventSubscriptions template reference -API Version: 2017-09-15-preview -## Template format - -To create a Microsoft.EventGrid/eventSubscriptions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventGrid/eventSubscriptions", - "apiVersion": "2017-09-15-preview", - "properties": { - "destination": {}, - "filter": { - "subjectBeginsWith": "string", - "subjectEndsWith": "string", - "includedEventTypes": [ - "string" - ], - "isSubjectCaseSensitive": "boolean" - }, - "labels": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventGrid/eventSubscriptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.EventGrid/eventSubscriptions | -| apiVersion | enum | Yes | 2017-09-15-preview | -| properties | object | Yes | Properties of the event subscription - [EventSubscriptionProperties object](#EventSubscriptionProperties) | - - - -### EventSubscriptionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| destination | object | No | Information about the destination where events have to be delivered for the event subscription. - [EventSubscriptionDestination object](#EventSubscriptionDestination) | -| filter | object | No | Information about the filter for the event subscription. - [EventSubscriptionFilter object](#EventSubscriptionFilter) | -| labels | array | No | List of user defined labels. - string | - - - -### EventSubscriptionFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subjectBeginsWith | string | No | 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 | No | An optional string to filter events for an event subscription based on a resource path suffix. -Wildcard characters are not supported in this path. | -| includedEventTypes | array | No | A list of applicable event types that need to be part of the event subscription. -If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list. - string | -| isSubjectCaseSensitive | boolean | No | Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter -should be compared in a case sensitive manner. | - diff --git a/test/Resource/Expected/EventGrid/2017-09-15-preview/topics.md b/test/Resource/Expected/EventGrid/2017-09-15-preview/topics.md deleted file mode 100644 index bab790d..0000000 --- a/test/Resource/Expected/EventGrid/2017-09-15-preview/topics.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.EventGrid/topics template reference -API Version: 2017-09-15-preview -## Template format - -To create a Microsoft.EventGrid/topics resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventGrid/topics", - "apiVersion": "2017-09-15-preview", - "location": "string", - "tags": {}, - "properties": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventGrid/topics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.EventGrid/topics | -| apiVersion | enum | Yes | 2017-09-15-preview | -| location | string | Yes | Location of the resource | -| tags | object | No | Tags of the resource | -| properties | object | Yes | Properties of the topic - [TopicProperties object](#TopicProperties) | - diff --git a/test/Resource/Expected/EventGrid/2018-01-01/Microsoft.EventGrid.json b/test/Resource/Expected/EventGrid/2018-01-01/Microsoft.EventGrid.json deleted file mode 100644 index 52e4744..0000000 --- a/test/Resource/Expected/EventGrid/2018-01-01/Microsoft.EventGrid.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2018-01-01/Microsoft.EventGrid.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.EventGrid", - "description": "Microsoft EventGrid Resource Types", - "resourceDefinitions": { - "topics": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.EventGrid/topics" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2018-01-01" - ] - }, - "location": { - "type": "string", - "description": "Location of the resource" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tags of the resource" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/TopicProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the topic" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.EventGrid/topics" - } - }, - "definitions": { - "TopicProperties": { - "type": "object", - "properties": {}, - "description": "Properties of the Topic" - } - } -} diff --git a/test/Resource/Expected/EventGrid/2018-01-01/eventSubscriptions.md b/test/Resource/Expected/EventGrid/2018-01-01/eventSubscriptions.md deleted file mode 100644 index c5a0ee4..0000000 --- a/test/Resource/Expected/EventGrid/2018-01-01/eventSubscriptions.md +++ /dev/null @@ -1,64 +0,0 @@ -# Microsoft.EventGrid/eventSubscriptions template reference -API Version: 2018-01-01 -## Template format - -To create a Microsoft.EventGrid/eventSubscriptions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventGrid/eventSubscriptions", - "apiVersion": "2018-01-01", - "properties": { - "destination": {}, - "filter": { - "subjectBeginsWith": "string", - "subjectEndsWith": "string", - "includedEventTypes": [ - "string" - ], - "isSubjectCaseSensitive": "boolean" - }, - "labels": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventGrid/eventSubscriptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.EventGrid/eventSubscriptions | -| apiVersion | enum | Yes | 2018-01-01 | -| properties | object | Yes | Properties of the event subscription - [EventSubscriptionProperties object](#EventSubscriptionProperties) | - - - -### EventSubscriptionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| destination | object | No | Information about the destination where events have to be delivered for the event subscription. - [EventSubscriptionDestination object](#EventSubscriptionDestination) | -| filter | object | No | Information about the filter for the event subscription. - [EventSubscriptionFilter object](#EventSubscriptionFilter) | -| labels | array | No | List of user defined labels. - string | - - - -### EventSubscriptionFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subjectBeginsWith | string | No | 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 | No | An optional string to filter events for an event subscription based on a resource path suffix. -Wildcard characters are not supported in this path. | -| includedEventTypes | array | No | A list of applicable event types that need to be part of the event subscription. -If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list. - string | -| isSubjectCaseSensitive | boolean | No | Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter -should be compared in a case sensitive manner. | - diff --git a/test/Resource/Expected/EventGrid/2018-01-01/topics.md b/test/Resource/Expected/EventGrid/2018-01-01/topics.md deleted file mode 100644 index 6ab9751..0000000 --- a/test/Resource/Expected/EventGrid/2018-01-01/topics.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.EventGrid/topics template reference -API Version: 2018-01-01 -## Template format - -To create a Microsoft.EventGrid/topics resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventGrid/topics", - "apiVersion": "2018-01-01", - "location": "string", - "tags": {}, - "properties": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventGrid/topics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.EventGrid/topics | -| apiVersion | enum | Yes | 2018-01-01 | -| location | string | Yes | Location of the resource | -| tags | object | No | Tags of the resource | -| properties | object | Yes | Properties of the topic - [TopicProperties object](#TopicProperties) | - diff --git a/test/Resource/Expected/EventHub/2015-08-01/namespaces.md b/test/Resource/Expected/EventHub/2015-08-01/namespaces.md deleted file mode 100644 index 649f153..0000000 --- a/test/Resource/Expected/EventHub/2015-08-01/namespaces.md +++ /dev/null @@ -1,67 +0,0 @@ -# Microsoft.EventHub/namespaces template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.EventHub/namespaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces", - "apiVersion": "2015-08-01", - "location": "string", - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "tags": {}, - "properties": { - "status": "string", - "provisioningState": "string", - "createdAt": "string", - "updatedAt": "string", - "serviceBusEndpoint": "string", - "enabled": "boolean" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The Namespace name | -| type | enum | Yes | Microsoft.EventHub/namespaces | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | Yes | Namespace location. | -| sku | object | No | [Sku object](#Sku) | -| tags | object | No | Namespace tags. | -| properties | object | Yes | [NamespaceProperties object](#NamespaceProperties) | -| resources | array | No | [eventhubs](./namespaces/eventhubs.md) [AuthorizationRules](./namespaces/AuthorizationRules.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of this SKU. - Basic or Standard | -| tier | enum | Yes | The billing tier of this particular SKU. - Basic, Standard, Premium | -| capacity | integer | No | The Event Hubs throughput units. | - - - -### NamespaceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | State of the Namespace. - Unknown, Creating, Created, Activating, Enabling, Active, Disabling, Disabled, SoftDeleting, SoftDeleted, Removing, Removed, Failed | -| provisioningState | string | No | Provisioning state of the Namespace. | -| createdAt | string | No | The time the Namespace was created. | -| updatedAt | string | No | The time the Namespace was updated. | -| serviceBusEndpoint | string | No | Endpoint you can use to perform Service Bus operations. | -| enabled | boolean | No | Specifies whether this instance is enabled. | - diff --git a/test/Resource/Expected/EventHub/2015-08-01/namespaces/AuthorizationRules.md b/test/Resource/Expected/EventHub/2015-08-01/namespaces/AuthorizationRules.md deleted file mode 100644 index e341e61..0000000 --- a/test/Resource/Expected/EventHub/2015-08-01/namespaces/AuthorizationRules.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.EventHub/namespaces/AuthorizationRules template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.EventHub/namespaces/AuthorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces/AuthorizationRules", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces/AuthorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorization rule name. | -| type | enum | Yes | Microsoft.EventHub/namespaces/AuthorizationRules | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | No | Data center location. | -| properties | object | Yes | [SharedAccessAuthorizationRuleProperties object](#SharedAccessAuthorizationRuleProperties) | - - - -### SharedAccessAuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs.md b/test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs.md deleted file mode 100644 index 4fd3a6f..0000000 --- a/test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.EventHub/namespaces/eventhubs template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.EventHub/namespaces/eventhubs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces/eventhubs", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "messageRetentionInDays": "integer", - "partitionCount": "integer", - "status": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces/eventhubs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The Event Hub name | -| type | enum | Yes | Microsoft.EventHub/namespaces/eventhubs | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | Yes | Location of the resource. | -| properties | object | Yes | [EventHubProperties object](#EventHubProperties) | -| resources | array | No | [consumergroups](./eventhubs/consumergroups.md) [authorizationRules](./eventhubs/authorizationRules.md) | - - - -### EventHubProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageRetentionInDays | integer | No | Number of days to retain the events for this Event Hub. | -| partitionCount | integer | No | Number of partitions created for the Event Hub. | -| status | enum | No | Enumerates the possible values for the status of the Event Hub. - Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Unknown | - diff --git a/test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs/authorizationRules.md b/test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs/authorizationRules.md deleted file mode 100644 index a3d49f4..0000000 --- a/test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs/authorizationRules.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.EventHub/namespaces/eventhubs/authorizationRules template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.EventHub/namespaces/eventhubs/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces/eventhubs/authorizationRules", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces/eventhubs/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorization rule name. | -| type | enum | Yes | Microsoft.EventHub/namespaces/eventhubs/authorizationRules | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | No | Data center location. | -| properties | object | Yes | [SharedAccessAuthorizationRuleProperties object](#SharedAccessAuthorizationRuleProperties) | - - - -### SharedAccessAuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs/consumergroups.md b/test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs/consumergroups.md deleted file mode 100644 index 447a416..0000000 --- a/test/Resource/Expected/EventHub/2015-08-01/namespaces/eventhubs/consumergroups.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.EventHub/namespaces/eventhubs/consumergroups template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.EventHub/namespaces/eventhubs/consumergroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces/eventhubs/consumergroups", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "userMetadata": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces/eventhubs/consumergroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The consumer group name | -| type | enum | Yes | Microsoft.EventHub/namespaces/eventhubs/consumergroups | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | Yes | Location of the resource. | -| properties | object | Yes | [ConsumerGroupProperties object](#ConsumerGroupProperties) | - - - -### ConsumerGroupProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| userMetadata | string | No | The user metadata. | - diff --git a/test/Resource/Expected/EventHub/2017-04-01/namespaces.md b/test/Resource/Expected/EventHub/2017-04-01/namespaces.md deleted file mode 100644 index 5aa6600..0000000 --- a/test/Resource/Expected/EventHub/2017-04-01/namespaces.md +++ /dev/null @@ -1,59 +0,0 @@ -# Microsoft.EventHub/namespaces template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.EventHub/namespaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces", - "apiVersion": "2017-04-01", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "properties": { - "isAutoInflateEnabled": "boolean", - "maximumThroughputUnits": "integer" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The Namespace name | -| type | enum | Yes | Microsoft.EventHub/namespaces | -| apiVersion | enum | Yes | 2017-04-01 | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | Properties of sku resource - [Sku object](#Sku) | -| properties | object | Yes | Namespace properties supplied for create namespace operation. - [EHNamespaceProperties object](#EHNamespaceProperties) | -| resources | array | No | [eventhubs](./namespaces/eventhubs.md) [disasterRecoveryConfigs](./namespaces/disasterRecoveryConfigs.md) [AuthorizationRules](./namespaces/AuthorizationRules.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Name of this SKU. - Basic or Standard | -| tier | enum | No | The billing tier of this particular SKU. - Basic or Standard | -| capacity | integer | No | The Event Hubs throughput units, vaule should be 0 to 20 throughput units. | - - - -### EHNamespaceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| isAutoInflateEnabled | boolean | No | Value that indicates whether AutoInflate is enabled for eventhub namespace. | -| maximumThroughputUnits | integer | No | Upper limit of throughput units when AutoInflate is enabled, vaule should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) | - diff --git a/test/Resource/Expected/EventHub/2017-04-01/namespaces/AuthorizationRules.md b/test/Resource/Expected/EventHub/2017-04-01/namespaces/AuthorizationRules.md deleted file mode 100644 index 42c3393..0000000 --- a/test/Resource/Expected/EventHub/2017-04-01/namespaces/AuthorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.EventHub/namespaces/AuthorizationRules template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.EventHub/namespaces/AuthorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces/AuthorizationRules", - "apiVersion": "2017-04-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces/AuthorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorization rule name. | -| type | enum | Yes | Microsoft.EventHub/namespaces/AuthorizationRules | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties supplied to create or update AuthorizationRule - [AuthorizationRuleProperties object](#AuthorizationRuleProperties) | - - - -### AuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/EventHub/2017-04-01/namespaces/disasterRecoveryConfigs.md b/test/Resource/Expected/EventHub/2017-04-01/namespaces/disasterRecoveryConfigs.md deleted file mode 100644 index b7f65aa..0000000 --- a/test/Resource/Expected/EventHub/2017-04-01/namespaces/disasterRecoveryConfigs.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.EventHub/namespaces/disasterRecoveryConfigs template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.EventHub/namespaces/disasterRecoveryConfigs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces/disasterRecoveryConfigs", - "apiVersion": "2017-04-01", - "properties": { - "partnerNamespace": "string", - "alternateName": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces/disasterRecoveryConfigs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The Disaster Recovery configuration name | -| type | enum | Yes | Microsoft.EventHub/namespaces/disasterRecoveryConfigs | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties required to the Create Or Update Alias(Disaster Recovery configurations) - [ArmDisasterRecoveryProperties object](#ArmDisasterRecoveryProperties) | - - - -### ArmDisasterRecoveryProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| partnerNamespace | string | No | ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairning | -| alternateName | string | No | Alternate name specified when alias and namespace names are same. | - diff --git a/test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs.md b/test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs.md deleted file mode 100644 index 7a0461a..0000000 --- a/test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs.md +++ /dev/null @@ -1,85 +0,0 @@ -# Microsoft.EventHub/namespaces/eventhubs template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.EventHub/namespaces/eventhubs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces/eventhubs", - "apiVersion": "2017-04-01", - "properties": { - "messageRetentionInDays": "integer", - "partitionCount": "integer", - "status": "string", - "captureDescription": { - "enabled": "boolean", - "encoding": "string", - "intervalInSeconds": "integer", - "sizeLimitInBytes": "integer", - "destination": { - "name": "string", - "properties": { - "storageAccountResourceId": "string", - "blobContainer": "string", - "archiveNameFormat": "string" - } - } - } - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces/eventhubs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The Event Hub name | -| type | enum | Yes | Microsoft.EventHub/namespaces/eventhubs | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties supplied to the Create Or Update Event Hub operation. - [EventhubProperties object](#EventhubProperties) | -| resources | array | No | [consumergroups](./eventhubs/consumergroups.md) [authorizationRules](./eventhubs/authorizationRules.md) | - - - -### EventhubProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageRetentionInDays | integer | No | Number of days to retain the events for this Event Hub, value should be 1 to 7 days | -| partitionCount | integer | No | Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. | -| status | enum | No | Enumerates the possible values for the status of the Event Hub. - Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Unknown | -| captureDescription | object | No | Properties of capture description - [CaptureDescription object](#CaptureDescription) | - - - -### CaptureDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | A value that indicates whether capture description is enabled. | -| encoding | enum | No | Enumerates the possible values for the encoding format of capture description. - Avro or AvroDeflate | -| intervalInSeconds | integer | No | 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 | integer | No | 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 | -| destination | object | No | Properties of Destination where capture will be stored. (Storage Account, Blob Names) - [Destination object](#Destination) | - - - -### Destination object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Name for capture destination | -| properties | object | No | Properties describing the storage account, blob container and acrchive anme format for capture destination - [DestinationProperties object](#DestinationProperties) | - - - -### DestinationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountResourceId | string | No | Resource id of the storage account to be used to create the blobs | -| blobContainer | string | No | Blob container Name | -| archiveNameFormat | string | No | 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 | - diff --git a/test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs/authorizationRules.md b/test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs/authorizationRules.md deleted file mode 100644 index ccacb8c..0000000 --- a/test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs/authorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.EventHub/namespaces/eventhubs/authorizationRules template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.EventHub/namespaces/eventhubs/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces/eventhubs/authorizationRules", - "apiVersion": "2017-04-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces/eventhubs/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorization rule name. | -| type | enum | Yes | Microsoft.EventHub/namespaces/eventhubs/authorizationRules | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties supplied to create or update AuthorizationRule - [AuthorizationRuleProperties object](#AuthorizationRuleProperties) | - - - -### AuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs/consumergroups.md b/test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs/consumergroups.md deleted file mode 100644 index dfb1b1d..0000000 --- a/test/Resource/Expected/EventHub/2017-04-01/namespaces/eventhubs/consumergroups.md +++ /dev/null @@ -1,36 +0,0 @@ -# Microsoft.EventHub/namespaces/eventhubs/consumergroups template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.EventHub/namespaces/eventhubs/consumergroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.EventHub/namespaces/eventhubs/consumergroups", - "apiVersion": "2017-04-01", - "properties": { - "userMetadata": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.EventHub/namespaces/eventhubs/consumergroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The consumer group name | -| type | enum | Yes | Microsoft.EventHub/namespaces/eventhubs/consumergroups | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Single item in List or Get Consumer group operation - [ConsumerGroupProperties object](#ConsumerGroupProperties) | - - - -### ConsumerGroupProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| userMetadata | string | No | Usermetadata 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. | - diff --git a/test/Resource/Expected/Logic/2015-02-01-preview/Microsoft.Logic.json b/test/Resource/Expected/Logic/2015-02-01-preview/Microsoft.Logic.json deleted file mode 100644 index a96c6d5..0000000 --- a/test/Resource/Expected/Logic/2015-02-01-preview/Microsoft.Logic.json +++ /dev/null @@ -1,390 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-02-01-preview/Microsoft.Logic.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Logic", - "description": "Microsoft Logic Resource Types", - "resourceDefinitions": { - "workflows": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/workflows" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-02-01-preview" - ] - }, - "id": { - "type": "string", - "description": "Gets or sets the resource id." - }, - "location": { - "type": "string", - "description": "Gets or sets the resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WorkflowProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the workflow properties." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/workflows_accessKeys_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/workflows" - }, - "workflows_accessKeys": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/workflows/accessKeys" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-02-01-preview" - ] - }, - "id": { - "type": "string", - "description": "Gets or sets the resource id." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WorkflowAccessKeyProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the workflow access key properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/workflows/accessKeys" - } - }, - "definitions": { - "ContentHash": { - "type": "object", - "properties": { - "algorithm": { - "type": "string", - "description": "Gets or sets the algorithm." - }, - "value": { - "type": "string", - "description": "Gets or sets the value." - } - } - }, - "ContentLink": { - "type": "object", - "properties": { - "uri": { - "type": "string", - "description": "Gets or sets the content link URI." - }, - "contentVersion": { - "type": "string", - "description": "Gets or sets the content version." - }, - "contentSize": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the content size." - }, - "contentHash": { - "oneOf": [ - { - "$ref": "#/definitions/ContentHash" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the content hash." - }, - "metadata": { - "type": "object", - "properties": {}, - "description": "Gets or sets the metadata." - } - } - }, - "ResourceReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the resource id." - } - } - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Free", - "Shared", - "Basic", - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the name." - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference to plan." - } - } - }, - "WorkflowAccessKeyProperties": { - "type": "object", - "properties": { - "notBefore": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the not-before time." - }, - "notAfter": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the not-after time." - } - } - }, - "WorkflowParameter": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "String", - "SecureString", - "Int", - "Float", - "Bool", - "Array", - "Object", - "SecureObject" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the type." - }, - "value": { - "type": "object", - "properties": {}, - "description": "Gets or sets the value." - }, - "metadata": { - "type": "object", - "properties": {}, - "description": "Gets or sets the metadata." - } - } - }, - "WorkflowProperties": { - "type": "object", - "properties": { - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Enabled", - "Disabled", - "Deleted", - "Suspended" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the state." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the sku." - }, - "definitionLink": { - "oneOf": [ - { - "$ref": "#/definitions/ContentLink" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the link to definition." - }, - "definition": { - "type": "object", - "properties": {}, - "description": "Gets or sets the definition." - }, - "parametersLink": { - "oneOf": [ - { - "$ref": "#/definitions/ContentLink" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the link to parameters." - }, - "parameters": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/WorkflowParameter" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the parameters." - } - } - }, - "workflows_accessKeys_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "accessKeys" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-02-01-preview" - ] - }, - "id": { - "type": "string", - "description": "Gets or sets the resource id." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WorkflowAccessKeyProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the workflow access key properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/workflows/accessKeys" - } - } -} diff --git a/test/Resource/Expected/Logic/2015-02-01-preview/workflows.md b/test/Resource/Expected/Logic/2015-02-01-preview/workflows.md deleted file mode 100644 index a72fe59..0000000 --- a/test/Resource/Expected/Logic/2015-02-01-preview/workflows.md +++ /dev/null @@ -1,111 +0,0 @@ -# Microsoft.Logic/workflows template reference -API Version: 2015-02-01-preview -## Template format - -To create a Microsoft.Logic/workflows resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/workflows", - "apiVersion": "2015-02-01-preview", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "state": "string", - "sku": { - "name": "string", - "plan": { - "id": "string" - } - }, - "definitionLink": { - "uri": "string", - "contentVersion": "string", - "contentSize": "integer", - "contentHash": { - "algorithm": "string", - "value": "string" - }, - "metadata": {} - }, - "definition": {}, - "parametersLink": { - "uri": "string", - "contentVersion": "string", - "contentSize": "integer", - "contentHash": { - "algorithm": "string", - "value": "string" - }, - "metadata": {} - }, - "parameters": {} - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/workflows object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/workflows | -| apiVersion | enum | Yes | 2015-02-01-preview | -| id | string | No | Gets or sets the resource id. | -| location | string | No | Gets or sets the resource location. | -| tags | object | No | Gets or sets the resource tags. | -| properties | object | Yes | Gets or sets the workflow properties. - [WorkflowProperties object](#WorkflowProperties) | -| resources | array | No | [accessKeys](./workflows/accessKeys.md) | - - - -### WorkflowProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| state | enum | No | Gets or sets the state. - NotSpecified, Enabled, Disabled, Deleted, Suspended | -| sku | object | No | Gets or sets the sku. - [Sku object](#Sku) | -| definitionLink | object | No | Gets or sets the link to definition. - [ContentLink object](#ContentLink) | -| definition | object | No | Gets or sets the definition. | -| parametersLink | object | No | Gets or sets the link to parameters. - [ContentLink object](#ContentLink) | -| parameters | object | No | Gets or sets the parameters. | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gets or sets the name. - NotSpecified, Free, Shared, Basic, Standard, Premium | -| plan | object | No | Gets or sets the reference to plan. - [ResourceReference object](#ResourceReference) | - - - -### ContentLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| uri | string | No | Gets or sets the content link URI. | -| contentVersion | string | No | Gets or sets the content version. | -| contentSize | integer | No | Gets or sets the content size. | -| contentHash | object | No | Gets or sets the content hash. - [ContentHash object](#ContentHash) | -| metadata | object | No | Gets or sets the metadata. | - - - -### ResourceReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Gets or sets the resource id. | - - - -### ContentHash object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| algorithm | string | No | Gets or sets the algorithm. | -| value | string | No | Gets or sets the value. | - diff --git a/test/Resource/Expected/Logic/2015-02-01-preview/workflows/accessKeys.md b/test/Resource/Expected/Logic/2015-02-01-preview/workflows/accessKeys.md deleted file mode 100644 index 2ff1424..0000000 --- a/test/Resource/Expected/Logic/2015-02-01-preview/workflows/accessKeys.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Logic/workflows/accessKeys template reference -API Version: 2015-02-01-preview -## Template format - -To create a Microsoft.Logic/workflows/accessKeys resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/workflows/accessKeys", - "apiVersion": "2015-02-01-preview", - "id": "string", - "properties": { - "notBefore": "string", - "notAfter": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/workflows/accessKeys object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/workflows/accessKeys | -| apiVersion | enum | Yes | 2015-02-01-preview | -| id | string | No | Gets or sets the resource id. | -| properties | object | Yes | Gets or sets the workflow access key properties. - [WorkflowAccessKeyProperties object](#WorkflowAccessKeyProperties) | - - - -### WorkflowAccessKeyProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| notBefore | string | No | Gets or sets the not-before time. | -| notAfter | string | No | Gets or sets the not-after time. | - diff --git a/test/Resource/Expected/Logic/2015-08-01-preview/Microsoft.Logic.json b/test/Resource/Expected/Logic/2015-08-01-preview/Microsoft.Logic.json deleted file mode 100644 index e7662fd..0000000 --- a/test/Resource/Expected/Logic/2015-08-01-preview/Microsoft.Logic.json +++ /dev/null @@ -1,4092 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-08-01-preview/Microsoft.Logic.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Logic", - "description": "Microsoft Logic Resource Types", - "resourceDefinitions": { - "integrationAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "type": "object", - "properties": {}, - "description": "The integration account properties." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sku." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/integrationAccounts_schemas_childResource" - }, - { - "$ref": "#/definitions/integrationAccounts_maps_childResource" - }, - { - "$ref": "#/definitions/integrationAccounts_partners_childResource" - }, - { - "$ref": "#/definitions/integrationAccounts_agreements_childResource" - }, - { - "$ref": "#/definitions/integrationAccounts_certificates_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts" - }, - "integrationAccounts_agreements": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/agreements" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountAgreementProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account agreement properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/agreements" - }, - "integrationAccounts_certificates": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountCertificateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account certificate properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/certificates" - }, - "integrationAccounts_maps": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/maps" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountMapProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account map properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/maps" - }, - "integrationAccounts_partners": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/partners" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountPartnerProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account partner properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/partners" - }, - "integrationAccounts_schemas": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/schemas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountSchemaProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account schema properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/schemas" - } - }, - "definitions": { - "AgreementContent": { - "type": "object", - "properties": { - "AS2": { - "oneOf": [ - { - "$ref": "#/definitions/AS2AgreementContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AS2 agreement content." - }, - "X12": { - "oneOf": [ - { - "$ref": "#/definitions/X12AgreementContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 agreement content." - }, - "Edifact": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactAgreementContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT agreement content." - } - } - }, - "AS2AcknowledgementConnectionSettings": { - "type": "object", - "properties": { - "ignoreCertificateNameMismatch": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to ignore mismatch in certificate name." - }, - "supportHttpStatusCodeContinue": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to support HTTP status code 'CONTINUE'." - }, - "keepHttpConnectionAlive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to keep the connection alive." - }, - "unfoldHttpHeaders": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to unfold the HTTP headers." - } - } - }, - "AS2AgreementContent": { - "type": "object", - "properties": { - "receiveAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/AS2OneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AS2 one-way receive agreement." - }, - "sendAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/AS2OneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AS2 one-way send agreement." - } - } - }, - "AS2EnvelopeSettings": { - "type": "object", - "properties": { - "messageContentType": { - "type": "string", - "description": "The message content type." - }, - "transmitFileNameInMimeHeader": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to transmit file name in mime header." - }, - "fileNameTemplate": { - "type": "string", - "description": "The template for file name." - }, - "SuspendMessageOnFileNameGenerationError": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to suspend message on file name generation error." - }, - "AutogenerateFileName": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to auto generate file name." - } - } - }, - "AS2ErrorSettings": { - "type": "object", - "properties": { - "SuspendDuplicateMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to suspend duplicate message." - }, - "ResendIfMdnNotReceived": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to resend message If MDN is not received." - } - } - }, - "AS2MdnSettings": { - "type": "object", - "properties": { - "needMdn": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send or request a MDN." - }, - "signMdn": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the MDN needs to be signed or not." - }, - "sendMdnAsynchronously": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send the asynchronous MDN." - }, - "receiptDeliveryUrl": { - "type": "string", - "description": "The receipt delivery URL." - }, - "dispositionNotificationTo": { - "type": "string", - "description": "The disposition notification to header value." - }, - "signOutboundMdnIfOptional": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to sign the outbound MDN if optional." - }, - "mdnText": { - "type": "string", - "description": "The MDN text." - }, - "sendInboundMdnToMessageBox": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send inbound MDN to message box." - }, - "micHashingAlgorithm": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "SHA2256", - "SHA2384", - "SHA2512" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The signing or hashing algorithm." - } - } - }, - "AS2MessageConnectionSettings": { - "type": "object", - "properties": { - "ignoreCertificateNameMismatch": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to ignore mismatch in certificate name." - }, - "supportHttpStatusCodeContinue": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to support HTTP status code 'CONTINUE'." - }, - "keepHttpConnectionAlive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to keep the connection alive." - }, - "unfoldHttpHeaders": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to unfold the HTTP headers." - } - } - }, - "AS2OneWayAgreement": { - "type": "object", - "properties": { - "senderBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sender business identity" - }, - "receiverBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The receiver business identity" - }, - "protocolSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2ProtocolSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AS2 protocol settings." - } - } - }, - "AS2ProtocolSettings": { - "type": "object", - "properties": { - "messageConnectionSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2MessageConnectionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The message connection settings." - }, - "acknowledgementConnectionSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2AcknowledgementConnectionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement connection settings." - }, - "mdnSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2MdnSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The MDN settings." - }, - "securitySettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2SecuritySettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The security settings." - }, - "validationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2ValidationSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The validation settings." - }, - "envelopeSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2EnvelopeSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The envelope settings." - }, - "errorSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2ErrorSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The error settings." - } - } - }, - "AS2SecuritySettings": { - "type": "object", - "properties": { - "overrideGroupSigningCertificate": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send or request a MDN." - }, - "signingCertificateName": { - "type": "string", - "description": "The name of the signing certificate." - }, - "encryptionCertificateName": { - "type": "string", - "description": "The name of the encryption certificate." - }, - "enableNrrForInboundEncodedMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for inbound encoded messages." - }, - "enableNrrForInboundDecodedMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for inbound decoded messages." - }, - "enableNrrForOutboundMdn": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for outbound MDN." - }, - "enableNrrForOutboundEncodedMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for outbound encoded messages." - }, - "enableNrrForOutboundDecodedMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for outbound decoded messages." - }, - "enableNrrForInboundMdn": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for inbound MDN." - } - } - }, - "AS2ValidationSettings": { - "type": "object", - "properties": { - "overrideMessageProperties": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to override incoming message properties with those in agreement." - }, - "encryptMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the message has to be encrypted." - }, - "signMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the message has to be signed." - }, - "compressMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the message has to be compressed." - }, - "checkDuplicateMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate message." - }, - "interchangeDuplicatesValidityDays": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of days to look back for duplicate interchange." - }, - "checkCertificateRevocationListOnSend": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for certificate revocation list on send." - }, - "checkCertificateRevocationListOnReceive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for certificate revocation list on receive." - }, - "encryptionAlgorithm": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "DES3", - "RC2", - "AES128", - "AES192", - "AES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption algorithm." - } - } - }, - "B2BPartnerContent": { - "type": "object", - "properties": { - "businessIdentities": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BusinessIdentity" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of partner business identities." - } - } - }, - "BusinessIdentity": { - "type": "object", - "properties": { - "Qualifier": { - "type": "string", - "description": "The business identity qualifier." - }, - "Value": { - "type": "string", - "description": "The business identity value." - } - } - }, - "EdifactAcknowledgementSettings": { - "type": "object", - "properties": { - "needTechnicalAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether technical acknowledgement is needed." - }, - "batchTechnicalAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch the technical acknowledgements." - }, - "needFunctionalAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether functional acknowledgement is needed." - }, - "batchFunctionalAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch functional acknowledgements." - }, - "needLoopForValidMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether a loop is needed for valid messages." - }, - "sendSynchronousAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send synchronous acknowledgement." - }, - "acknowledgementControlNumberPrefix": { - "type": "string", - "description": "The acknowledgement control number prefix." - }, - "acknowledgementControlNumberSuffix": { - "type": "string", - "description": "The acknowledgement control number suffix." - }, - "acknowledgementControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement control number lower bound." - }, - "acknowledgementControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement control number upper bound." - }, - "rolloverAcknowledgementControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover acknowledgement control number." - } - } - }, - "EdifactAgreementContent": { - "type": "object", - "properties": { - "receiveAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactOneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT one-way receive agreement." - }, - "sendAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactOneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT one-way send agreement." - } - } - }, - "EdifactDelimiterOverride": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id." - }, - "messageVersion": { - "type": "string", - "description": "The message version." - }, - "messageRelease": { - "type": "string", - "description": "The message releaseversion." - }, - "dataElementSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The data element separator." - }, - "componentSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component separator." - }, - "segmentTerminator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator." - }, - "repetitionSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The repetition separator." - }, - "segmentTerminatorSuffix": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "CR", - "LF", - "CRLF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator suffix." - }, - "decimalPointIndicator": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Comma", - "Decimal" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The decimal point indicator." - }, - "releaseIndicator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The release indicator." - }, - "messageAssociationAssignedCode": { - "type": "string", - "description": "The message association assigned code." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace on which this delimiter settings has to be applied." - } - } - }, - "EdifactEnvelopeOverride": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id on which this envelope settings has to be applied." - }, - "messageVersion": { - "type": "string", - "description": "The message version on which this envelope settings has to be applied." - }, - "messageRelease": { - "type": "string", - "description": "The message release version on which this envelope settings has to be applied." - }, - "messageAssociationAssignedCode": { - "type": "string", - "description": "The message association assigned code." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace on which this envelope settings has to be applied." - }, - "functionalGroupId": { - "type": "string", - "description": "The functional group id." - }, - "senderApplicationQualifier": { - "type": "string", - "description": "The sender application qualifier." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "receiverApplicationQualifier": { - "type": "string", - "description": "The receiver application qualifier." - }, - "receiverApplicationId": { - "type": "string", - "description": "The receiver application id." - }, - "controllingAgencyCode": { - "type": "string", - "description": "The controlling agency code." - }, - "groupHeaderMessageVersion": { - "type": "string", - "description": "The group header message version." - }, - "groupHeaderMessageRelease": { - "type": "string", - "description": "The group header message release." - }, - "associationAssignedCode": { - "type": "string", - "description": "The association assigned code." - }, - "applicationPassword": { - "type": "string", - "description": "The application password." - } - } - }, - "EdifactEnvelopeSettings": { - "type": "object", - "properties": { - "groupAssociationAssignedCode": { - "type": "string", - "description": "The group association assigned code." - }, - "communicationAgreementId": { - "type": "string", - "description": "The communication agreement id." - }, - "applyDelimiterStringAdvice": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to apply delimiter string advice." - }, - "createGroupingSegments": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to create grouping segments." - }, - "enableDefaultGroupHeaders": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable default group headers." - }, - "recipientReferencePasswordValue": { - "type": "string", - "description": "The recipient reference password value." - }, - "recipientReferencePasswordQualifier": { - "type": "string", - "description": "The recipient reference password qualifier." - }, - "applicationReferenceId": { - "type": "string", - "description": "The application reference id." - }, - "processingPriorityCode": { - "type": "string", - "description": "The processing priority code." - }, - "interchangeControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interchange control number lower bound." - }, - "interchangeControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interchange control number upper bound." - }, - "rolloverInterchangeControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover interchange control number." - }, - "interchangeControlNumberPrefix": { - "type": "string", - "description": "The interchange control number prefix." - }, - "interchangeControlNumberSuffix": { - "type": "string", - "description": "The interchange control number suffix." - }, - "senderReverseRoutingAddress": { - "type": "string", - "description": "The sender reverse routing address." - }, - "receiverReverseRoutingAddress": { - "type": "string", - "description": "The receiver reverse routing address." - }, - "functionalGroupId": { - "type": "string", - "description": "The functional group id." - }, - "groupControllingAgencyCode": { - "type": "string", - "description": "The group controlling agency code." - }, - "groupMessageVersion": { - "type": "string", - "description": "The group message version." - }, - "groupMessageRelease": { - "type": "string", - "description": "The group message release." - }, - "groupControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group control number lower bound." - }, - "groupControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group control number upper bound." - }, - "rolloverGroupControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover group control number." - }, - "groupControlNumberPrefix": { - "type": "string", - "description": "The group control number prefix." - }, - "groupControlNumberSuffix": { - "type": "string", - "description": "The group control number suffix." - }, - "groupApplicationReceiverQualifier": { - "type": "string", - "description": "The group application receiver qualifier." - }, - "groupApplicationReceiverId": { - "type": "string", - "description": "The group application receiver id." - }, - "groupApplicationSenderQualifier": { - "type": "string", - "description": "The group application sender qualifier." - }, - "groupApplicationSenderId": { - "type": "string", - "description": "The group application sender id." - }, - "groupApplicationPassword": { - "type": "string", - "description": "The group application password." - }, - "overwriteExistingTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to overwrite existing transaction set control number." - }, - "transactionSetControlNumberPrefix": { - "type": "string", - "description": "The transaction set control number prefix." - }, - "transactionSetControlNumberSuffix": { - "type": "string", - "description": "The transaction set control number suffix." - }, - "transactionSetControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transaction set control number lower bound." - }, - "transactionSetControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transaction set control number upper bound." - }, - "rolloverTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover transaction set control number." - }, - "isTestInterchange": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the message is a test interchange." - }, - "senderInternalIdentification": { - "type": "string", - "description": "The sender internal identification." - }, - "senderInternalSubIdentification": { - "type": "string", - "description": "The sender internal sub identification." - }, - "receiverInternalIdentification": { - "type": "string", - "description": "The receiver internal identification." - }, - "receiverInternalSubIdentification": { - "type": "string", - "description": "The receiver internal sub identification." - } - } - }, - "EdifactFramingSettings": { - "type": "object", - "properties": { - "serviceCodeListDirectoryVersion": { - "type": "string", - "description": "The service code list directory version." - }, - "characterEncoding": { - "type": "string", - "description": "The character encoding." - }, - "protocolVersion": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The protocol version." - }, - "dataElementSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The data element separator." - }, - "componentSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component separator." - }, - "segmentTerminator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator." - }, - "releaseIndicator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The release indicator." - }, - "repetitionSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The repetition separator." - }, - "characterSet": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "UNOB", - "UNOA", - "UNOC", - "UNOD", - "UNOE", - "UNOF", - "UNOG", - "UNOH", - "UNOI", - "UNOJ", - "UNOK", - "UNOX", - "UNOY", - "KECA" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT frame setting characterSet." - }, - "decimalPointIndicator": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Comma", - "Decimal" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT frame setting decimal indicator." - }, - "segmentTerminatorSuffix": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "CR", - "LF", - "CRLF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT frame setting segment terminator suffix." - } - } - }, - "EdifactMessageFilter": { - "type": "object", - "properties": { - "messageFilterType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Include", - "Exclude" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The message filter type." - } - } - }, - "EdifactMessageIdentifier": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id on which this envelope settings has to be applied." - } - } - }, - "EdifactOneWayAgreement": { - "type": "object", - "properties": { - "senderBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sender business identity" - }, - "receiverBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The receiver business identity" - }, - "protocolSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactProtocolSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT protocol settings." - } - } - }, - "EdifactProcessingSettings": { - "type": "object", - "properties": { - "maskSecurityInfo": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to mask security information." - }, - "preserveInterchange": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to preserve interchange." - }, - "suspendInterchangeOnError": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to suspend interchange on error." - }, - "createEmptyXmlTagsForTrailingSeparators": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to create empty xml tags for trailing separators." - }, - "useDotAsDecimalSeparator": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to use dot as decimal separator." - } - } - }, - "EdifactProtocolSettings": { - "type": "object", - "properties": { - "validationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactValidationSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT validation settings." - }, - "framingSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactFramingSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT framing settings." - }, - "envelopeSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactEnvelopeSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT envelope settings." - }, - "acknowledgementSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactAcknowledgementSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT acknowledgement settings." - }, - "messageFilter": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactMessageFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT message filter." - }, - "processingSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactProcessingSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT processing Settings." - }, - "envelopeOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactEnvelopeOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT envelope override settings." - }, - "messageFilterList": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactMessageIdentifier" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT message filter list." - }, - "schemaReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactSchemaReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT schema references." - }, - "validationOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactValidationOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT validation override settings." - }, - "edifactDelimiterOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactDelimiterOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT delimiter override settings." - } - } - }, - "EdifactSchemaReference": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id." - }, - "messageVersion": { - "type": "string", - "description": "The message version." - }, - "messageRelease": { - "type": "string", - "description": "The message release version." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "senderApplicationQualifier": { - "type": "string", - "description": "The sender application qualifier." - }, - "associationAssignedCode": { - "type": "string", - "description": "The association assigned code." - }, - "schemaName": { - "type": "string", - "description": "The schema name." - } - } - }, - "EdifactValidationOverride": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id on which the validation settings has to be applied." - }, - "enforceCharacterSet": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate character Set." - }, - "validateEDITypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate EDI types." - }, - "validateXSDTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate XSD types." - }, - "allowLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." - }, - "trailingSeparatorPolicy": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "NotAllowed", - "Optional", - "Mandatory" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The trailing separator policy." - }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." - } - } - }, - "EdifactValidationSettings": { - "type": "object", - "properties": { - "validateCharacterSet": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate character set in the message." - }, - "checkDuplicateInterchangeControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate interchange control number." - }, - "interchangeControlNumberValidityDays": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The validity period of interchange control number." - }, - "checkDuplicateGroupControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate group control number." - }, - "checkDuplicateTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate transaction set control number." - }, - "validateEDITypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to Whether to validate EDI types." - }, - "validateXSDTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to Whether to validate XSD types." - }, - "allowLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." - }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." - }, - "trailingSeparatorPolicy": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "NotAllowed", - "Optional", - "Mandatory" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The trailing separator policy." - } - } - }, - "IntegrationAccountAgreementProperties": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - }, - "agreementType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "AS2", - "X12", - "Edifact" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The agreement type." - }, - "hostPartner": { - "type": "string", - "description": "The host partner." - }, - "guestPartner": { - "type": "string", - "description": "The guest partner." - }, - "hostIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The host identity." - }, - "guestIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The guest identity." - }, - "content": { - "oneOf": [ - { - "$ref": "#/definitions/AgreementContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The agreement content." - } - } - }, - "IntegrationAccountCertificateProperties": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - }, - "key": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultKeyReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The key details in the key vault." - }, - "publicCertificate": { - "type": "string", - "description": "The public certificate." - } - } - }, - "IntegrationAccountMapProperties": { - "type": "object", - "properties": { - "mapType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Xslt" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The map type." - }, - "content": { - "type": "object", - "properties": {}, - "description": "The content." - }, - "contentType": { - "type": "string", - "description": "The content type." - }, - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - } - } - }, - "IntegrationAccountPartnerProperties": { - "type": "object", - "properties": { - "partnerType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "B2B" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The partner type." - }, - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - }, - "content": { - "oneOf": [ - { - "$ref": "#/definitions/PartnerContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The partner content." - } - } - }, - "IntegrationAccountSchemaProperties": { - "type": "object", - "properties": { - "schemaType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Xml" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The schema type." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace." - }, - "content": { - "type": "object", - "properties": {}, - "description": "The content." - }, - "contentType": { - "type": "string", - "description": "The content type." - }, - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - } - } - }, - "IntegrationAccountSku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Free", - "Shared", - "Basic", - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sku name." - } - } - }, - "integrationAccounts_agreements_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "agreements" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountAgreementProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account agreement properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/agreements" - }, - "integrationAccounts_certificates_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountCertificateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account certificate properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/certificates" - }, - "integrationAccounts_maps_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "maps" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountMapProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account map properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/maps" - }, - "integrationAccounts_partners_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "partners" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountPartnerProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account partner properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/partners" - }, - "integrationAccounts_schemas_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "schemas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01-preview" - ] - }, - "id": { - "type": "string", - "description": "The resource id." - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountSchemaProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account schema properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/schemas" - }, - "KeyVaultKeyReference": { - "type": "object", - "properties": { - "keyVault": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultKeyReferenceKeyVault" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The key vault reference." - }, - "keyName": { - "type": "string", - "description": "The private key name in key vault." - }, - "keyVersion": { - "type": "string", - "description": "The private key version in key vault." - } - } - }, - "KeyVaultKeyReferenceKeyVault": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The resource id." - } - }, - "description": "The key vault reference." - }, - "PartnerContent": { - "type": "object", - "properties": { - "b2b": { - "oneOf": [ - { - "$ref": "#/definitions/B2BPartnerContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The B2B partner content." - } - } - }, - "X12AcknowledgementSettings": { - "type": "object", - "properties": { - "needTechnicalAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether technical acknowledgement is needed." - }, - "batchTechnicalAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch the technical acknowledgements." - }, - "needFunctionalAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether functional acknowledgement is needed." - }, - "functionalAcknowledgementVersion": { - "type": "string", - "description": "The functional acknowledgement version." - }, - "batchFunctionalAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch functional acknowledgements." - }, - "needImplementationAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether implementation acknowledgement is needed." - }, - "implementationAcknowledgementVersion": { - "type": "string", - "description": "The implementation acknowledgement version." - }, - "batchImplementationAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch implementation acknowledgements." - }, - "needLoopForValidMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether a loop is needed for valid messages." - }, - "sendSynchronousAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send synchronous acknowledgement." - }, - "acknowledgementControlNumberPrefix": { - "type": "string", - "description": "The acknowledgement control number prefix." - }, - "acknowledgementControlNumberSuffix": { - "type": "string", - "description": "The acknowledgement control number suffix." - }, - "acknowledgementControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement control number lower bound." - }, - "acknowledgementControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement control number upper bound." - }, - "rolloverAcknowledgementControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover acknowledgement control number." - } - } - }, - "X12AgreementContent": { - "type": "object", - "properties": { - "receiveAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/X12OneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 one-way receive agreement." - }, - "sendAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/X12OneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 one-way send agreement." - } - } - }, - "X12DelimiterOverrides": { - "type": "object", - "properties": { - "protocolVersion": { - "type": "string", - "description": "The protocol version." - }, - "messageId": { - "type": "string", - "description": "The message id." - }, - "dataElementSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The data element separator." - }, - "componentSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component separator." - }, - "segmentTerminator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator." - }, - "segmentTerminatorSuffix": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "CR", - "LF", - "CRLF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator suffix." - }, - "replaceCharacter": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The replacement character." - }, - "replaceSeparatorsInPayload": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to replace separators in payload." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace on which this delimiter settings has to be applied." - } - } - }, - "X12EnvelopeOverride": { - "type": "object", - "properties": { - "targetNamespace": { - "type": "string", - "description": "The target namespace on which this envelope settings has to be applied." - }, - "protocolVersion": { - "type": "string", - "description": "The protocol version on which this envelope settings has to be applied." - }, - "messageId": { - "type": "string", - "description": "The message id on which this envelope settings has to be applied." - }, - "responsibleAgencyCode": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The responsible agency code." - }, - "headerVersion": { - "type": "string", - "description": "The header version." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "receiverApplicationId": { - "type": "string", - "description": "The receiver application id." - }, - "functionalIdentifierCode": { - "type": "string", - "description": "The functional identifier code." - }, - "dateFormat": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "CCYYMMDD", - "YYMMDD" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The date format." - }, - "timeFormat": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "HHMM", - "HHMMSS", - "HHMMSSdd", - "HHMMSSd" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The time format." - } - } - }, - "X12EnvelopeSettings": { - "type": "object", - "properties": { - "controlStandardsId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The controls standards id." - }, - "useControlStandardsIdAsRepetitionCharacter": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to use control standards id as repetition character." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "receiverApplicationId": { - "type": "string", - "description": "The receiver application id." - }, - "controlVersionNumber": { - "type": "string", - "description": "The control version number." - }, - "interchangeControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interchange control number lower bound." - }, - "interchangeControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interchange control number upper bound." - }, - "rolloverInterchangeControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover interchange control number." - }, - "enableDefaultGroupHeaders": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable default group headers." - }, - "functionalGroupId": { - "type": "string", - "description": "The functional group id." - }, - "groupControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group control number lower bound." - }, - "groupControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group control number upper bound." - }, - "rolloverGroupControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover group control number." - }, - "groupHeaderAgencyCode": { - "type": "string", - "description": "The group header agency code." - }, - "groupHeaderVersion": { - "type": "string", - "description": "The group header version." - }, - "transactionSetControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transaction set control number lower bound." - }, - "transactionSetControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transaction set control number upper bound." - }, - "rolloverTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover transaction set control number." - }, - "transactionSetControlNumberPrefix": { - "type": "string", - "description": "The transaction set control number prefix." - }, - "transactionSetControlNumberSuffix": { - "type": "string", - "description": "The transaction set control number suffix." - }, - "overwriteExistingTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to overwrite existing transaction set control number." - }, - "groupHeaderDateFormat": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "CCYYMMDD", - "YYMMDD" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group header date format." - }, - "groupHeaderTimeFormat": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "HHMM", - "HHMMSS", - "HHMMSSdd", - "HHMMSSd" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group header time format." - }, - "usageIndicator": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Test", - "Information", - "Production" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The usage indicator." - } - } - }, - "X12FramingSettings": { - "type": "object", - "properties": { - "dataElementSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The data element separator." - }, - "componentSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component separator." - }, - "replaceSeparatorsInPayload": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to replace separators in payload." - }, - "replaceCharacter": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The replacement character." - }, - "segmentTerminator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator." - }, - "characterSet": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Basic", - "Extended", - "UTF8" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 character set." - }, - "segmentTerminatorSuffix": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "CR", - "LF", - "CRLF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator suffix." - } - } - }, - "X12MessageFilter": { - "type": "object", - "properties": { - "messageFilterType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Include", - "Exclude" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The message filter type." - } - } - }, - "X12MessageIdentifier": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id." - } - } - }, - "X12OneWayAgreement": { - "type": "object", - "properties": { - "senderBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sender business identity" - }, - "receiverBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The receiver business identity" - }, - "protocolSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12ProtocolSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 protocol settings." - } - } - }, - "X12ProcessingSettings": { - "type": "object", - "properties": { - "maskSecurityInfo": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to mask security information." - }, - "convertImpliedDecimal": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to convert numerical type to implied decimal." - }, - "preserveInterchange": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to preserve interchange." - }, - "suspendInterchangeOnError": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to suspend interchange on error." - }, - "createEmptyXmlTagsForTrailingSeparators": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to create empty xml tags for trailing separators." - }, - "useDotAsDecimalSeparator": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to use dot as decimal separator." - } - } - }, - "X12ProtocolSettings": { - "type": "object", - "properties": { - "validationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12ValidationSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 validation settings." - }, - "framingSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12FramingSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 framing settings." - }, - "envelopeSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12EnvelopeSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 envelope settings." - }, - "acknowledgementSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12AcknowledgementSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 acknowledgment settings." - }, - "messageFilter": { - "oneOf": [ - { - "$ref": "#/definitions/X12MessageFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 message filter." - }, - "securitySettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12SecuritySettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 security settings." - }, - "processingSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12ProcessingSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 processing settings." - }, - "envelopeOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12EnvelopeOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 envelope override settings." - }, - "validationOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12ValidationOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 validation override settings." - }, - "messageFilterList": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12MessageIdentifier" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 message filter list." - }, - "schemaReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12SchemaReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 schema references." - }, - "x12DelimiterOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12DelimiterOverrides" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 delimiter override settings." - } - } - }, - "X12SchemaReference": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "schemaVersion": { - "type": "string", - "description": "The schema version." - }, - "schemaName": { - "type": "string", - "description": "The schema name." - } - } - }, - "X12SecuritySettings": { - "type": "object", - "properties": { - "authorizationQualifier": { - "type": "string", - "description": "The authorization qualifier." - }, - "authorizationValue": { - "type": "string", - "description": "The authorization value." - }, - "securityQualifier": { - "type": "string", - "description": "The security qualifier." - }, - "passwordValue": { - "type": "string", - "description": "The password value." - } - } - }, - "X12ValidationOverride": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id on which the validation settings has to be applied." - }, - "validateEDITypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate EDI types." - }, - "validateXSDTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate XSD types." - }, - "allowLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." - }, - "validateCharacterSet": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate character Set." - }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." - }, - "trailingSeparatorPolicy": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "NotAllowed", - "Optional", - "Mandatory" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The trailing separator policy." - } - } - }, - "X12ValidationSettings": { - "type": "object", - "properties": { - "validateCharacterSet": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate character set in the message." - }, - "checkDuplicateInterchangeControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate interchange control number." - }, - "interchangeControlNumberValidityDays": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The validity period of interchange control number." - }, - "checkDuplicateGroupControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate group control number." - }, - "checkDuplicateTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate transaction set control number." - }, - "validateEDITypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to Whether to validate EDI types." - }, - "validateXSDTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to Whether to validate XSD types." - }, - "allowLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." - }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." - }, - "trailingSeparatorPolicy": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "NotAllowed", - "Optional", - "Mandatory" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The trailing separator policy." - } - } - } - } -} diff --git a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts.md b/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts.md deleted file mode 100644 index fd69a8d..0000000 --- a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Logic/integrationAccounts template reference -API Version: 2015-08-01-preview -## Template format - -To create a Microsoft.Logic/integrationAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts", - "apiVersion": "2015-08-01-preview", - "id": "string", - "location": "string", - "tags": {}, - "properties": {}, - "sku": { - "name": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts | -| apiVersion | enum | Yes | 2015-08-01-preview | -| id | string | No | The resource id. | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account properties. | -| sku | object | No | The sku. - [IntegrationAccountSku object](#IntegrationAccountSku) | -| resources | array | No | [certificates](./integrationAccounts/certificates.md) [agreements](./integrationAccounts/agreements.md) [partners](./integrationAccounts/partners.md) [maps](./integrationAccounts/maps.md) [schemas](./integrationAccounts/schemas.md) | - - - -### IntegrationAccountSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | The sku name. - NotSpecified, Free, Shared, Basic, Standard, Premium | - diff --git a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/agreements.md b/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/agreements.md deleted file mode 100644 index a4eb21f..0000000 --- a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/agreements.md +++ /dev/null @@ -1,1378 +0,0 @@ -# Microsoft.Logic/integrationAccounts/agreements template reference -API Version: 2015-08-01-preview -## Template format - -To create a Microsoft.Logic/integrationAccounts/agreements resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/agreements", - "apiVersion": "2015-08-01-preview", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "metadata": {}, - "agreementType": "string", - "hostPartner": "string", - "guestPartner": "string", - "hostIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "guestIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "content": { - "AS2": { - "receiveAgreement": { - "senderBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "receiverBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "protocolSettings": { - "messageConnectionSettings": { - "ignoreCertificateNameMismatch": "boolean", - "supportHttpStatusCodeContinue": "boolean", - "keepHttpConnectionAlive": "boolean", - "unfoldHttpHeaders": "boolean" - }, - "acknowledgementConnectionSettings": { - "ignoreCertificateNameMismatch": "boolean", - "supportHttpStatusCodeContinue": "boolean", - "keepHttpConnectionAlive": "boolean", - "unfoldHttpHeaders": "boolean" - }, - "mdnSettings": { - "needMdn": "boolean", - "signMdn": "boolean", - "sendMdnAsynchronously": "boolean", - "receiptDeliveryUrl": "string", - "dispositionNotificationTo": "string", - "signOutboundMdnIfOptional": "boolean", - "mdnText": "string", - "sendInboundMdnToMessageBox": "boolean", - "micHashingAlgorithm": "string" - }, - "securitySettings": { - "overrideGroupSigningCertificate": "boolean", - "signingCertificateName": "string", - "encryptionCertificateName": "string", - "enableNrrForInboundEncodedMessages": "boolean", - "enableNrrForInboundDecodedMessages": "boolean", - "enableNrrForOutboundMdn": "boolean", - "enableNrrForOutboundEncodedMessages": "boolean", - "enableNrrForOutboundDecodedMessages": "boolean", - "enableNrrForInboundMdn": "boolean" - }, - "validationSettings": { - "overrideMessageProperties": "boolean", - "encryptMessage": "boolean", - "signMessage": "boolean", - "compressMessage": "boolean", - "checkDuplicateMessage": "boolean", - "interchangeDuplicatesValidityDays": "integer", - "checkCertificateRevocationListOnSend": "boolean", - "checkCertificateRevocationListOnReceive": "boolean", - "encryptionAlgorithm": "string" - }, - "envelopeSettings": { - "messageContentType": "string", - "transmitFileNameInMimeHeader": "boolean", - "fileNameTemplate": "string", - "SuspendMessageOnFileNameGenerationError": "boolean", - "AutogenerateFileName": "boolean" - }, - "errorSettings": { - "SuspendDuplicateMessage": "boolean", - "ResendIfMdnNotReceived": "boolean" - } - } - }, - "sendAgreement": { - "senderBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "receiverBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "protocolSettings": { - "messageConnectionSettings": { - "ignoreCertificateNameMismatch": "boolean", - "supportHttpStatusCodeContinue": "boolean", - "keepHttpConnectionAlive": "boolean", - "unfoldHttpHeaders": "boolean" - }, - "acknowledgementConnectionSettings": { - "ignoreCertificateNameMismatch": "boolean", - "supportHttpStatusCodeContinue": "boolean", - "keepHttpConnectionAlive": "boolean", - "unfoldHttpHeaders": "boolean" - }, - "mdnSettings": { - "needMdn": "boolean", - "signMdn": "boolean", - "sendMdnAsynchronously": "boolean", - "receiptDeliveryUrl": "string", - "dispositionNotificationTo": "string", - "signOutboundMdnIfOptional": "boolean", - "mdnText": "string", - "sendInboundMdnToMessageBox": "boolean", - "micHashingAlgorithm": "string" - }, - "securitySettings": { - "overrideGroupSigningCertificate": "boolean", - "signingCertificateName": "string", - "encryptionCertificateName": "string", - "enableNrrForInboundEncodedMessages": "boolean", - "enableNrrForInboundDecodedMessages": "boolean", - "enableNrrForOutboundMdn": "boolean", - "enableNrrForOutboundEncodedMessages": "boolean", - "enableNrrForOutboundDecodedMessages": "boolean", - "enableNrrForInboundMdn": "boolean" - }, - "validationSettings": { - "overrideMessageProperties": "boolean", - "encryptMessage": "boolean", - "signMessage": "boolean", - "compressMessage": "boolean", - "checkDuplicateMessage": "boolean", - "interchangeDuplicatesValidityDays": "integer", - "checkCertificateRevocationListOnSend": "boolean", - "checkCertificateRevocationListOnReceive": "boolean", - "encryptionAlgorithm": "string" - }, - "envelopeSettings": { - "messageContentType": "string", - "transmitFileNameInMimeHeader": "boolean", - "fileNameTemplate": "string", - "SuspendMessageOnFileNameGenerationError": "boolean", - "AutogenerateFileName": "boolean" - }, - "errorSettings": { - "SuspendDuplicateMessage": "boolean", - "ResendIfMdnNotReceived": "boolean" - } - } - } - }, - "X12": { - "receiveAgreement": { - "senderBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "receiverBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "protocolSettings": { - "validationSettings": { - "validateCharacterSet": "boolean", - "checkDuplicateInterchangeControlNumber": "boolean", - "interchangeControlNumberValidityDays": "integer", - "checkDuplicateGroupControlNumber": "boolean", - "checkDuplicateTransactionSetControlNumber": "boolean", - "validateEDITypes": "boolean", - "validateXSDTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - }, - "framingSettings": { - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "replaceSeparatorsInPayload": "boolean", - "replaceCharacter": "integer", - "segmentTerminator": "integer", - "characterSet": "string", - "segmentTerminatorSuffix": "string" - }, - "envelopeSettings": { - "controlStandardsId": "integer", - "useControlStandardsIdAsRepetitionCharacter": "boolean", - "senderApplicationId": "string", - "receiverApplicationId": "string", - "controlVersionNumber": "string", - "interchangeControlNumberLowerBound": "integer", - "interchangeControlNumberUpperBound": "integer", - "rolloverInterchangeControlNumber": "boolean", - "enableDefaultGroupHeaders": "boolean", - "functionalGroupId": "string", - "groupControlNumberLowerBound": "integer", - "groupControlNumberUpperBound": "integer", - "rolloverGroupControlNumber": "boolean", - "groupHeaderAgencyCode": "string", - "groupHeaderVersion": "string", - "transactionSetControlNumberLowerBound": "integer", - "transactionSetControlNumberUpperBound": "integer", - "rolloverTransactionSetControlNumber": "boolean", - "transactionSetControlNumberPrefix": "string", - "transactionSetControlNumberSuffix": "string", - "overwriteExistingTransactionSetControlNumber": "boolean", - "groupHeaderDateFormat": "string", - "groupHeaderTimeFormat": "string", - "usageIndicator": "string" - }, - "acknowledgementSettings": { - "needTechnicalAcknowledgement": "boolean", - "batchTechnicalAcknowledgements": "boolean", - "needFunctionalAcknowledgement": "boolean", - "functionalAcknowledgementVersion": "string", - "batchFunctionalAcknowledgements": "boolean", - "needImplementationAcknowledgement": "boolean", - "implementationAcknowledgementVersion": "string", - "batchImplementationAcknowledgements": "boolean", - "needLoopForValidMessages": "boolean", - "sendSynchronousAcknowledgement": "boolean", - "acknowledgementControlNumberPrefix": "string", - "acknowledgementControlNumberSuffix": "string", - "acknowledgementControlNumberLowerBound": "integer", - "acknowledgementControlNumberUpperBound": "integer", - "rolloverAcknowledgementControlNumber": "boolean" - }, - "messageFilter": { - "messageFilterType": "string" - }, - "securitySettings": { - "authorizationQualifier": "string", - "authorizationValue": "string", - "securityQualifier": "string", - "passwordValue": "string" - }, - "processingSettings": { - "maskSecurityInfo": "boolean", - "convertImpliedDecimal": "boolean", - "preserveInterchange": "boolean", - "suspendInterchangeOnError": "boolean", - "createEmptyXmlTagsForTrailingSeparators": "boolean", - "useDotAsDecimalSeparator": "boolean" - }, - "envelopeOverrides": [ - { - "targetNamespace": "string", - "protocolVersion": "string", - "messageId": "string", - "responsibleAgencyCode": "integer", - "headerVersion": "string", - "senderApplicationId": "string", - "receiverApplicationId": "string", - "functionalIdentifierCode": "string", - "dateFormat": "string", - "timeFormat": "string" - } - ], - "validationOverrides": [ - { - "messageId": "string", - "validateEDITypes": "boolean", - "validateXSDTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "validateCharacterSet": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - } - ], - "messageFilterList": [ - { - "messageId": "string" - } - ], - "schemaReferences": [ - { - "messageId": "string", - "senderApplicationId": "string", - "schemaVersion": "string", - "schemaName": "string" - } - ], - "x12DelimiterOverrides": [ - { - "protocolVersion": "string", - "messageId": "string", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "segmentTerminatorSuffix": "string", - "replaceCharacter": "integer", - "replaceSeparatorsInPayload": "boolean", - "targetNamespace": "string" - } - ] - } - }, - "sendAgreement": { - "senderBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "receiverBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "protocolSettings": { - "validationSettings": { - "validateCharacterSet": "boolean", - "checkDuplicateInterchangeControlNumber": "boolean", - "interchangeControlNumberValidityDays": "integer", - "checkDuplicateGroupControlNumber": "boolean", - "checkDuplicateTransactionSetControlNumber": "boolean", - "validateEDITypes": "boolean", - "validateXSDTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - }, - "framingSettings": { - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "replaceSeparatorsInPayload": "boolean", - "replaceCharacter": "integer", - "segmentTerminator": "integer", - "characterSet": "string", - "segmentTerminatorSuffix": "string" - }, - "envelopeSettings": { - "controlStandardsId": "integer", - "useControlStandardsIdAsRepetitionCharacter": "boolean", - "senderApplicationId": "string", - "receiverApplicationId": "string", - "controlVersionNumber": "string", - "interchangeControlNumberLowerBound": "integer", - "interchangeControlNumberUpperBound": "integer", - "rolloverInterchangeControlNumber": "boolean", - "enableDefaultGroupHeaders": "boolean", - "functionalGroupId": "string", - "groupControlNumberLowerBound": "integer", - "groupControlNumberUpperBound": "integer", - "rolloverGroupControlNumber": "boolean", - "groupHeaderAgencyCode": "string", - "groupHeaderVersion": "string", - "transactionSetControlNumberLowerBound": "integer", - "transactionSetControlNumberUpperBound": "integer", - "rolloverTransactionSetControlNumber": "boolean", - "transactionSetControlNumberPrefix": "string", - "transactionSetControlNumberSuffix": "string", - "overwriteExistingTransactionSetControlNumber": "boolean", - "groupHeaderDateFormat": "string", - "groupHeaderTimeFormat": "string", - "usageIndicator": "string" - }, - "acknowledgementSettings": { - "needTechnicalAcknowledgement": "boolean", - "batchTechnicalAcknowledgements": "boolean", - "needFunctionalAcknowledgement": "boolean", - "functionalAcknowledgementVersion": "string", - "batchFunctionalAcknowledgements": "boolean", - "needImplementationAcknowledgement": "boolean", - "implementationAcknowledgementVersion": "string", - "batchImplementationAcknowledgements": "boolean", - "needLoopForValidMessages": "boolean", - "sendSynchronousAcknowledgement": "boolean", - "acknowledgementControlNumberPrefix": "string", - "acknowledgementControlNumberSuffix": "string", - "acknowledgementControlNumberLowerBound": "integer", - "acknowledgementControlNumberUpperBound": "integer", - "rolloverAcknowledgementControlNumber": "boolean" - }, - "messageFilter": { - "messageFilterType": "string" - }, - "securitySettings": { - "authorizationQualifier": "string", - "authorizationValue": "string", - "securityQualifier": "string", - "passwordValue": "string" - }, - "processingSettings": { - "maskSecurityInfo": "boolean", - "convertImpliedDecimal": "boolean", - "preserveInterchange": "boolean", - "suspendInterchangeOnError": "boolean", - "createEmptyXmlTagsForTrailingSeparators": "boolean", - "useDotAsDecimalSeparator": "boolean" - }, - "envelopeOverrides": [ - { - "targetNamespace": "string", - "protocolVersion": "string", - "messageId": "string", - "responsibleAgencyCode": "integer", - "headerVersion": "string", - "senderApplicationId": "string", - "receiverApplicationId": "string", - "functionalIdentifierCode": "string", - "dateFormat": "string", - "timeFormat": "string" - } - ], - "validationOverrides": [ - { - "messageId": "string", - "validateEDITypes": "boolean", - "validateXSDTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "validateCharacterSet": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - } - ], - "messageFilterList": [ - { - "messageId": "string" - } - ], - "schemaReferences": [ - { - "messageId": "string", - "senderApplicationId": "string", - "schemaVersion": "string", - "schemaName": "string" - } - ], - "x12DelimiterOverrides": [ - { - "protocolVersion": "string", - "messageId": "string", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "segmentTerminatorSuffix": "string", - "replaceCharacter": "integer", - "replaceSeparatorsInPayload": "boolean", - "targetNamespace": "string" - } - ] - } - } - }, - "Edifact": { - "receiveAgreement": { - "senderBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "receiverBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "protocolSettings": { - "validationSettings": { - "validateCharacterSet": "boolean", - "checkDuplicateInterchangeControlNumber": "boolean", - "interchangeControlNumberValidityDays": "integer", - "checkDuplicateGroupControlNumber": "boolean", - "checkDuplicateTransactionSetControlNumber": "boolean", - "validateEDITypes": "boolean", - "validateXSDTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - }, - "framingSettings": { - "serviceCodeListDirectoryVersion": "string", - "characterEncoding": "string", - "protocolVersion": "integer", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "releaseIndicator": "integer", - "repetitionSeparator": "integer", - "characterSet": "string", - "decimalPointIndicator": "string", - "segmentTerminatorSuffix": "string" - }, - "envelopeSettings": { - "groupAssociationAssignedCode": "string", - "communicationAgreementId": "string", - "applyDelimiterStringAdvice": "boolean", - "createGroupingSegments": "boolean", - "enableDefaultGroupHeaders": "boolean", - "recipientReferencePasswordValue": "string", - "recipientReferencePasswordQualifier": "string", - "applicationReferenceId": "string", - "processingPriorityCode": "string", - "interchangeControlNumberLowerBound": "integer", - "interchangeControlNumberUpperBound": "integer", - "rolloverInterchangeControlNumber": "boolean", - "interchangeControlNumberPrefix": "string", - "interchangeControlNumberSuffix": "string", - "senderReverseRoutingAddress": "string", - "receiverReverseRoutingAddress": "string", - "functionalGroupId": "string", - "groupControllingAgencyCode": "string", - "groupMessageVersion": "string", - "groupMessageRelease": "string", - "groupControlNumberLowerBound": "integer", - "groupControlNumberUpperBound": "integer", - "rolloverGroupControlNumber": "boolean", - "groupControlNumberPrefix": "string", - "groupControlNumberSuffix": "string", - "groupApplicationReceiverQualifier": "string", - "groupApplicationReceiverId": "string", - "groupApplicationSenderQualifier": "string", - "groupApplicationSenderId": "string", - "groupApplicationPassword": "string", - "overwriteExistingTransactionSetControlNumber": "boolean", - "transactionSetControlNumberPrefix": "string", - "transactionSetControlNumberSuffix": "string", - "transactionSetControlNumberLowerBound": "integer", - "transactionSetControlNumberUpperBound": "integer", - "rolloverTransactionSetControlNumber": "boolean", - "isTestInterchange": "boolean", - "senderInternalIdentification": "string", - "senderInternalSubIdentification": "string", - "receiverInternalIdentification": "string", - "receiverInternalSubIdentification": "string" - }, - "acknowledgementSettings": { - "needTechnicalAcknowledgement": "boolean", - "batchTechnicalAcknowledgements": "boolean", - "needFunctionalAcknowledgement": "boolean", - "batchFunctionalAcknowledgements": "boolean", - "needLoopForValidMessages": "boolean", - "sendSynchronousAcknowledgement": "boolean", - "acknowledgementControlNumberPrefix": "string", - "acknowledgementControlNumberSuffix": "string", - "acknowledgementControlNumberLowerBound": "integer", - "acknowledgementControlNumberUpperBound": "integer", - "rolloverAcknowledgementControlNumber": "boolean" - }, - "messageFilter": { - "messageFilterType": "string" - }, - "processingSettings": { - "maskSecurityInfo": "boolean", - "preserveInterchange": "boolean", - "suspendInterchangeOnError": "boolean", - "createEmptyXmlTagsForTrailingSeparators": "boolean", - "useDotAsDecimalSeparator": "boolean" - }, - "envelopeOverrides": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "messageAssociationAssignedCode": "string", - "targetNamespace": "string", - "functionalGroupId": "string", - "senderApplicationQualifier": "string", - "senderApplicationId": "string", - "receiverApplicationQualifier": "string", - "receiverApplicationId": "string", - "controllingAgencyCode": "string", - "groupHeaderMessageVersion": "string", - "groupHeaderMessageRelease": "string", - "associationAssignedCode": "string", - "applicationPassword": "string" - } - ], - "messageFilterList": [ - { - "messageId": "string" - } - ], - "schemaReferences": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "senderApplicationId": "string", - "senderApplicationQualifier": "string", - "associationAssignedCode": "string", - "schemaName": "string" - } - ], - "validationOverrides": [ - { - "messageId": "string", - "enforceCharacterSet": "boolean", - "validateEDITypes": "boolean", - "validateXSDTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean" - } - ], - "edifactDelimiterOverrides": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "repetitionSeparator": "integer", - "segmentTerminatorSuffix": "string", - "decimalPointIndicator": "string", - "releaseIndicator": "integer", - "messageAssociationAssignedCode": "string", - "targetNamespace": "string" - } - ] - } - }, - "sendAgreement": { - "senderBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "receiverBusinessIdentity": { - "Qualifier": "string", - "Value": "string" - }, - "protocolSettings": { - "validationSettings": { - "validateCharacterSet": "boolean", - "checkDuplicateInterchangeControlNumber": "boolean", - "interchangeControlNumberValidityDays": "integer", - "checkDuplicateGroupControlNumber": "boolean", - "checkDuplicateTransactionSetControlNumber": "boolean", - "validateEDITypes": "boolean", - "validateXSDTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - }, - "framingSettings": { - "serviceCodeListDirectoryVersion": "string", - "characterEncoding": "string", - "protocolVersion": "integer", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "releaseIndicator": "integer", - "repetitionSeparator": "integer", - "characterSet": "string", - "decimalPointIndicator": "string", - "segmentTerminatorSuffix": "string" - }, - "envelopeSettings": { - "groupAssociationAssignedCode": "string", - "communicationAgreementId": "string", - "applyDelimiterStringAdvice": "boolean", - "createGroupingSegments": "boolean", - "enableDefaultGroupHeaders": "boolean", - "recipientReferencePasswordValue": "string", - "recipientReferencePasswordQualifier": "string", - "applicationReferenceId": "string", - "processingPriorityCode": "string", - "interchangeControlNumberLowerBound": "integer", - "interchangeControlNumberUpperBound": "integer", - "rolloverInterchangeControlNumber": "boolean", - "interchangeControlNumberPrefix": "string", - "interchangeControlNumberSuffix": "string", - "senderReverseRoutingAddress": "string", - "receiverReverseRoutingAddress": "string", - "functionalGroupId": "string", - "groupControllingAgencyCode": "string", - "groupMessageVersion": "string", - "groupMessageRelease": "string", - "groupControlNumberLowerBound": "integer", - "groupControlNumberUpperBound": "integer", - "rolloverGroupControlNumber": "boolean", - "groupControlNumberPrefix": "string", - "groupControlNumberSuffix": "string", - "groupApplicationReceiverQualifier": "string", - "groupApplicationReceiverId": "string", - "groupApplicationSenderQualifier": "string", - "groupApplicationSenderId": "string", - "groupApplicationPassword": "string", - "overwriteExistingTransactionSetControlNumber": "boolean", - "transactionSetControlNumberPrefix": "string", - "transactionSetControlNumberSuffix": "string", - "transactionSetControlNumberLowerBound": "integer", - "transactionSetControlNumberUpperBound": "integer", - "rolloverTransactionSetControlNumber": "boolean", - "isTestInterchange": "boolean", - "senderInternalIdentification": "string", - "senderInternalSubIdentification": "string", - "receiverInternalIdentification": "string", - "receiverInternalSubIdentification": "string" - }, - "acknowledgementSettings": { - "needTechnicalAcknowledgement": "boolean", - "batchTechnicalAcknowledgements": "boolean", - "needFunctionalAcknowledgement": "boolean", - "batchFunctionalAcknowledgements": "boolean", - "needLoopForValidMessages": "boolean", - "sendSynchronousAcknowledgement": "boolean", - "acknowledgementControlNumberPrefix": "string", - "acknowledgementControlNumberSuffix": "string", - "acknowledgementControlNumberLowerBound": "integer", - "acknowledgementControlNumberUpperBound": "integer", - "rolloverAcknowledgementControlNumber": "boolean" - }, - "messageFilter": { - "messageFilterType": "string" - }, - "processingSettings": { - "maskSecurityInfo": "boolean", - "preserveInterchange": "boolean", - "suspendInterchangeOnError": "boolean", - "createEmptyXmlTagsForTrailingSeparators": "boolean", - "useDotAsDecimalSeparator": "boolean" - }, - "envelopeOverrides": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "messageAssociationAssignedCode": "string", - "targetNamespace": "string", - "functionalGroupId": "string", - "senderApplicationQualifier": "string", - "senderApplicationId": "string", - "receiverApplicationQualifier": "string", - "receiverApplicationId": "string", - "controllingAgencyCode": "string", - "groupHeaderMessageVersion": "string", - "groupHeaderMessageRelease": "string", - "associationAssignedCode": "string", - "applicationPassword": "string" - } - ], - "messageFilterList": [ - { - "messageId": "string" - } - ], - "schemaReferences": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "senderApplicationId": "string", - "senderApplicationQualifier": "string", - "associationAssignedCode": "string", - "schemaName": "string" - } - ], - "validationOverrides": [ - { - "messageId": "string", - "enforceCharacterSet": "boolean", - "validateEDITypes": "boolean", - "validateXSDTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean" - } - ], - "edifactDelimiterOverrides": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "repetitionSeparator": "integer", - "segmentTerminatorSuffix": "string", - "decimalPointIndicator": "string", - "releaseIndicator": "integer", - "messageAssociationAssignedCode": "string", - "targetNamespace": "string" - } - ] - } - } - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/agreements object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/agreements | -| apiVersion | enum | Yes | 2015-08-01-preview | -| id | string | No | The resource id. | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account agreement properties. - [IntegrationAccountAgreementProperties object](#IntegrationAccountAgreementProperties) | - - - -### IntegrationAccountAgreementProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| metadata | object | No | The metadata. | -| agreementType | enum | No | The agreement type. - NotSpecified, AS2, X12, Edifact | -| hostPartner | string | No | The host partner. | -| guestPartner | string | No | The guest partner. | -| hostIdentity | object | No | The host identity. - [BusinessIdentity object](#BusinessIdentity) | -| guestIdentity | object | No | The guest identity. - [BusinessIdentity object](#BusinessIdentity) | -| content | object | No | The agreement content. - [AgreementContent object](#AgreementContent) | - - - -### BusinessIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| Qualifier | string | No | The business identity qualifier. | -| Value | string | No | The business identity value. | - - - -### AgreementContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| AS2 | object | No | The AS2 agreement content. - [AS2AgreementContent object](#AS2AgreementContent) | -| X12 | object | No | The X12 agreement content. - [X12AgreementContent object](#X12AgreementContent) | -| Edifact | object | No | The EDIFACT agreement content. - [EdifactAgreementContent object](#EdifactAgreementContent) | - - - -### AS2AgreementContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| receiveAgreement | object | No | The AS2 one-way receive agreement. - [AS2OneWayAgreement object](#AS2OneWayAgreement) | -| sendAgreement | object | No | The AS2 one-way send agreement. - [AS2OneWayAgreement object](#AS2OneWayAgreement) | - - - -### X12AgreementContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| receiveAgreement | object | No | The X12 one-way receive agreement. - [X12OneWayAgreement object](#X12OneWayAgreement) | -| sendAgreement | object | No | The X12 one-way send agreement. - [X12OneWayAgreement object](#X12OneWayAgreement) | - - - -### EdifactAgreementContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| receiveAgreement | object | No | The EDIFACT one-way receive agreement. - [EdifactOneWayAgreement object](#EdifactOneWayAgreement) | -| sendAgreement | object | No | The EDIFACT one-way send agreement. - [EdifactOneWayAgreement object](#EdifactOneWayAgreement) | - - - -### AS2OneWayAgreement object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| senderBusinessIdentity | object | No | The sender business identity - [BusinessIdentity object](#BusinessIdentity) | -| receiverBusinessIdentity | object | No | The receiver business identity - [BusinessIdentity object](#BusinessIdentity) | -| protocolSettings | object | No | The AS2 protocol settings. - [AS2ProtocolSettings object](#AS2ProtocolSettings) | - - - -### X12OneWayAgreement object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| senderBusinessIdentity | object | No | The sender business identity - [BusinessIdentity object](#BusinessIdentity) | -| receiverBusinessIdentity | object | No | The receiver business identity - [BusinessIdentity object](#BusinessIdentity) | -| protocolSettings | object | No | The X12 protocol settings. - [X12ProtocolSettings object](#X12ProtocolSettings) | - - - -### EdifactOneWayAgreement object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| senderBusinessIdentity | object | No | The sender business identity - [BusinessIdentity object](#BusinessIdentity) | -| receiverBusinessIdentity | object | No | The receiver business identity - [BusinessIdentity object](#BusinessIdentity) | -| protocolSettings | object | No | The EDIFACT protocol settings. - [EdifactProtocolSettings object](#EdifactProtocolSettings) | - - - -### AS2ProtocolSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageConnectionSettings | object | No | The message connection settings. - [AS2MessageConnectionSettings object](#AS2MessageConnectionSettings) | -| acknowledgementConnectionSettings | object | No | The acknowledgement connection settings. - [AS2AcknowledgementConnectionSettings object](#AS2AcknowledgementConnectionSettings) | -| mdnSettings | object | No | The MDN settings. - [AS2MdnSettings object](#AS2MdnSettings) | -| securitySettings | object | No | The security settings. - [AS2SecuritySettings object](#AS2SecuritySettings) | -| validationSettings | object | No | The validation settings. - [AS2ValidationSettings object](#AS2ValidationSettings) | -| envelopeSettings | object | No | The envelope settings. - [AS2EnvelopeSettings object](#AS2EnvelopeSettings) | -| errorSettings | object | No | The error settings. - [AS2ErrorSettings object](#AS2ErrorSettings) | - - - -### X12ProtocolSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| validationSettings | object | No | The X12 validation settings. - [X12ValidationSettings object](#X12ValidationSettings) | -| framingSettings | object | No | The X12 framing settings. - [X12FramingSettings object](#X12FramingSettings) | -| envelopeSettings | object | No | The X12 envelope settings. - [X12EnvelopeSettings object](#X12EnvelopeSettings) | -| acknowledgementSettings | object | No | The X12 acknowledgment settings. - [X12AcknowledgementSettings object](#X12AcknowledgementSettings) | -| messageFilter | object | No | The X12 message filter. - [X12MessageFilter object](#X12MessageFilter) | -| securitySettings | object | No | The X12 security settings. - [X12SecuritySettings object](#X12SecuritySettings) | -| processingSettings | object | No | The X12 processing settings. - [X12ProcessingSettings object](#X12ProcessingSettings) | -| envelopeOverrides | array | No | The X12 envelope override settings. - [X12EnvelopeOverride object](#X12EnvelopeOverride) | -| validationOverrides | array | No | The X12 validation override settings. - [X12ValidationOverride object](#X12ValidationOverride) | -| messageFilterList | array | No | The X12 message filter list. - [X12MessageIdentifier object](#X12MessageIdentifier) | -| schemaReferences | array | No | The X12 schema references. - [X12SchemaReference object](#X12SchemaReference) | -| x12DelimiterOverrides | array | No | The X12 delimiter override settings. - [X12DelimiterOverrides object](#X12DelimiterOverrides) | - - - -### EdifactProtocolSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| validationSettings | object | No | The EDIFACT validation settings. - [EdifactValidationSettings object](#EdifactValidationSettings) | -| framingSettings | object | No | The EDIFACT framing settings. - [EdifactFramingSettings object](#EdifactFramingSettings) | -| envelopeSettings | object | No | The EDIFACT envelope settings. - [EdifactEnvelopeSettings object](#EdifactEnvelopeSettings) | -| acknowledgementSettings | object | No | The EDIFACT acknowledgement settings. - [EdifactAcknowledgementSettings object](#EdifactAcknowledgementSettings) | -| messageFilter | object | No | The EDIFACT message filter. - [EdifactMessageFilter object](#EdifactMessageFilter) | -| processingSettings | object | No | The EDIFACT processing Settings. - [EdifactProcessingSettings object](#EdifactProcessingSettings) | -| envelopeOverrides | array | No | The EDIFACT envelope override settings. - [EdifactEnvelopeOverride object](#EdifactEnvelopeOverride) | -| messageFilterList | array | No | The EDIFACT message filter list. - [EdifactMessageIdentifier object](#EdifactMessageIdentifier) | -| schemaReferences | array | No | The EDIFACT schema references. - [EdifactSchemaReference object](#EdifactSchemaReference) | -| validationOverrides | array | No | The EDIFACT validation override settings. - [EdifactValidationOverride object](#EdifactValidationOverride) | -| edifactDelimiterOverrides | array | No | The EDIFACT delimiter override settings. - [EdifactDelimiterOverride object](#EdifactDelimiterOverride) | - - - -### AS2MessageConnectionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ignoreCertificateNameMismatch | boolean | No | The value indicating whether to ignore mismatch in certificate name. | -| supportHttpStatusCodeContinue | boolean | No | The value indicating whether to support HTTP status code 'CONTINUE'. | -| keepHttpConnectionAlive | boolean | No | The value indicating whether to keep the connection alive. | -| unfoldHttpHeaders | boolean | No | The value indicating whether to unfold the HTTP headers. | - - - -### AS2AcknowledgementConnectionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ignoreCertificateNameMismatch | boolean | No | The value indicating whether to ignore mismatch in certificate name. | -| supportHttpStatusCodeContinue | boolean | No | The value indicating whether to support HTTP status code 'CONTINUE'. | -| keepHttpConnectionAlive | boolean | No | The value indicating whether to keep the connection alive. | -| unfoldHttpHeaders | boolean | No | The value indicating whether to unfold the HTTP headers. | - - - -### AS2MdnSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| needMdn | boolean | No | The value indicating whether to send or request a MDN. | -| signMdn | boolean | No | The value indicating whether the MDN needs to be signed or not. | -| sendMdnAsynchronously | boolean | No | The value indicating whether to send the asynchronous MDN. | -| receiptDeliveryUrl | string | No | The receipt delivery URL. | -| dispositionNotificationTo | string | No | The disposition notification to header value. | -| signOutboundMdnIfOptional | boolean | No | The value indicating whether to sign the outbound MDN if optional. | -| mdnText | string | No | The MDN text. | -| sendInboundMdnToMessageBox | boolean | No | The value indicating whether to send inbound MDN to message box. | -| micHashingAlgorithm | enum | No | The signing or hashing algorithm. - NotSpecified, None, SHA2256, SHA2384, SHA2512 | - - - -### AS2SecuritySettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| overrideGroupSigningCertificate | boolean | No | The value indicating whether to send or request a MDN. | -| signingCertificateName | string | No | The name of the signing certificate. | -| encryptionCertificateName | string | No | The name of the encryption certificate. | -| enableNrrForInboundEncodedMessages | boolean | No | The value indicating whether to enable NRR for inbound encoded messages. | -| enableNrrForInboundDecodedMessages | boolean | No | The value indicating whether to enable NRR for inbound decoded messages. | -| enableNrrForOutboundMdn | boolean | No | The value indicating whether to enable NRR for outbound MDN. | -| enableNrrForOutboundEncodedMessages | boolean | No | The value indicating whether to enable NRR for outbound encoded messages. | -| enableNrrForOutboundDecodedMessages | boolean | No | The value indicating whether to enable NRR for outbound decoded messages. | -| enableNrrForInboundMdn | boolean | No | The value indicating whether to enable NRR for inbound MDN. | - - - -### AS2ValidationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| overrideMessageProperties | boolean | No | The value indicating whether to override incoming message properties with those in agreement. | -| encryptMessage | boolean | No | The value indicating whether the message has to be encrypted. | -| signMessage | boolean | No | The value indicating whether the message has to be signed. | -| compressMessage | boolean | No | The value indicating whether the message has to be compressed. | -| checkDuplicateMessage | boolean | No | The value indicating whether to check for duplicate message. | -| interchangeDuplicatesValidityDays | integer | No | The number of days to look back for duplicate interchange. | -| checkCertificateRevocationListOnSend | boolean | No | The value indicating whether to check for certificate revocation list on send. | -| checkCertificateRevocationListOnReceive | boolean | No | The value indicating whether to check for certificate revocation list on receive. | -| encryptionAlgorithm | enum | No | The encryption algorithm. - NotSpecified, None, DES3, RC2, AES128, AES192, AES256 | - - - -### AS2EnvelopeSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageContentType | string | No | The message content type. | -| transmitFileNameInMimeHeader | boolean | No | The value indicating whether to transmit file name in mime header. | -| fileNameTemplate | string | No | The template for file name. | -| SuspendMessageOnFileNameGenerationError | boolean | No | The value indicating whether to suspend message on file name generation error. | -| AutogenerateFileName | boolean | No | The value indicating whether to auto generate file name. | - - - -### AS2ErrorSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| SuspendDuplicateMessage | boolean | No | The value indicating whether to suspend duplicate message. | -| ResendIfMdnNotReceived | boolean | No | The value indicating whether to resend message If MDN is not received. | - - - -### X12ValidationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| validateCharacterSet | boolean | No | The value indicating whether to validate character set in the message. | -| checkDuplicateInterchangeControlNumber | boolean | No | The value indicating whether to check for duplicate interchange control number. | -| interchangeControlNumberValidityDays | integer | No | The validity period of interchange control number. | -| checkDuplicateGroupControlNumber | boolean | No | The value indicating whether to check for duplicate group control number. | -| checkDuplicateTransactionSetControlNumber | boolean | No | The value indicating whether to check for duplicate transaction set control number. | -| validateEDITypes | boolean | No | The value indicating whether to Whether to validate EDI types. | -| validateXSDTypes | boolean | No | The value indicating whether to Whether to validate XSD types. | -| allowLeadingAndTrailingSpacesAndZeroes | boolean | No | The value indicating whether to allow leading and trailing spaces and zeroes. | -| trimLeadingAndTrailingSpacesAndZeroes | boolean | No | The value indicating whether to trim leading and trailing spaces and zeroes. | -| trailingSeparatorPolicy | enum | No | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory | - - - -### X12FramingSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dataElementSeparator | integer | No | The data element separator. | -| componentSeparator | integer | No | The component separator. | -| replaceSeparatorsInPayload | boolean | No | The value indicating whether to replace separators in payload. | -| replaceCharacter | integer | No | The replacement character. | -| segmentTerminator | integer | No | The segment terminator. | -| characterSet | enum | No | The X12 character set. - NotSpecified, Basic, Extended, UTF8 | -| segmentTerminatorSuffix | enum | No | The segment terminator suffix. - NotSpecified, None, CR, LF, CRLF | - - - -### X12EnvelopeSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| controlStandardsId | integer | No | The controls standards id. | -| useControlStandardsIdAsRepetitionCharacter | boolean | No | The value indicating whether to use control standards id as repetition character. | -| senderApplicationId | string | No | The sender application id. | -| receiverApplicationId | string | No | The receiver application id. | -| controlVersionNumber | string | No | The control version number. | -| interchangeControlNumberLowerBound | integer | No | The interchange control number lower bound. | -| interchangeControlNumberUpperBound | integer | No | The interchange control number upper bound. | -| rolloverInterchangeControlNumber | boolean | No | The value indicating whether to rollover interchange control number. | -| enableDefaultGroupHeaders | boolean | No | The value indicating whether to enable default group headers. | -| functionalGroupId | string | No | The functional group id. | -| groupControlNumberLowerBound | integer | No | The group control number lower bound. | -| groupControlNumberUpperBound | integer | No | The group control number upper bound. | -| rolloverGroupControlNumber | boolean | No | The value indicating whether to rollover group control number. | -| groupHeaderAgencyCode | string | No | The group header agency code. | -| groupHeaderVersion | string | No | The group header version. | -| transactionSetControlNumberLowerBound | integer | No | The transaction set control number lower bound. | -| transactionSetControlNumberUpperBound | integer | No | The transaction set control number upper bound. | -| rolloverTransactionSetControlNumber | boolean | No | The value indicating whether to rollover transaction set control number. | -| transactionSetControlNumberPrefix | string | No | The transaction set control number prefix. | -| transactionSetControlNumberSuffix | string | No | The transaction set control number suffix. | -| overwriteExistingTransactionSetControlNumber | boolean | No | The value indicating whether to overwrite existing transaction set control number. | -| groupHeaderDateFormat | enum | No | The group header date format. - NotSpecified, CCYYMMDD, YYMMDD | -| groupHeaderTimeFormat | enum | No | The group header time format. - NotSpecified, HHMM, HHMMSS, HHMMSSdd, HHMMSSd | -| usageIndicator | enum | No | The usage indicator. - NotSpecified, Test, Information, Production | - - - -### X12AcknowledgementSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| needTechnicalAcknowledgement | boolean | No | The value indicating whether technical acknowledgement is needed. | -| batchTechnicalAcknowledgements | boolean | No | The value indicating whether to batch the technical acknowledgements. | -| needFunctionalAcknowledgement | boolean | No | The value indicating whether functional acknowledgement is needed. | -| functionalAcknowledgementVersion | string | No | The functional acknowledgement version. | -| batchFunctionalAcknowledgements | boolean | No | The value indicating whether to batch functional acknowledgements. | -| needImplementationAcknowledgement | boolean | No | The value indicating whether implementation acknowledgement is needed. | -| implementationAcknowledgementVersion | string | No | The implementation acknowledgement version. | -| batchImplementationAcknowledgements | boolean | No | The value indicating whether to batch implementation acknowledgements. | -| needLoopForValidMessages | boolean | No | The value indicating whether a loop is needed for valid messages. | -| sendSynchronousAcknowledgement | boolean | No | The value indicating whether to send synchronous acknowledgement. | -| acknowledgementControlNumberPrefix | string | No | The acknowledgement control number prefix. | -| acknowledgementControlNumberSuffix | string | No | The acknowledgement control number suffix. | -| acknowledgementControlNumberLowerBound | integer | No | The acknowledgement control number lower bound. | -| acknowledgementControlNumberUpperBound | integer | No | The acknowledgement control number upper bound. | -| rolloverAcknowledgementControlNumber | boolean | No | The value indicating whether to rollover acknowledgement control number. | - - - -### X12MessageFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageFilterType | enum | No | The message filter type. - NotSpecified, Include, Exclude | - - - -### X12SecuritySettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationQualifier | string | No | The authorization qualifier. | -| authorizationValue | string | No | The authorization value. | -| securityQualifier | string | No | The security qualifier. | -| passwordValue | string | No | The password value. | - - - -### X12ProcessingSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maskSecurityInfo | boolean | No | The value indicating whether to mask security information. | -| convertImpliedDecimal | boolean | No | The value indicating whether to convert numerical type to implied decimal. | -| preserveInterchange | boolean | No | The value indicating whether to preserve interchange. | -| suspendInterchangeOnError | boolean | No | The value indicating whether to suspend interchange on error. | -| createEmptyXmlTagsForTrailingSeparators | boolean | No | The value indicating whether to create empty xml tags for trailing separators. | -| useDotAsDecimalSeparator | boolean | No | The value indicating whether to use dot as decimal separator. | - - - -### X12EnvelopeOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| targetNamespace | string | No | The target namespace on which this envelope settings has to be applied. | -| protocolVersion | string | No | The protocol version on which this envelope settings has to be applied. | -| messageId | string | No | The message id on which this envelope settings has to be applied. | -| responsibleAgencyCode | integer | No | The responsible agency code. | -| headerVersion | string | No | The header version. | -| senderApplicationId | string | No | The sender application id. | -| receiverApplicationId | string | No | The receiver application id. | -| functionalIdentifierCode | string | No | The functional identifier code. | -| dateFormat | enum | No | The date format. - NotSpecified, CCYYMMDD, YYMMDD | -| timeFormat | enum | No | The time format. - NotSpecified, HHMM, HHMMSS, HHMMSSdd, HHMMSSd | - - - -### X12ValidationOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id on which the validation settings has to be applied. | -| validateEDITypes | boolean | No | The value indicating whether to validate EDI types. | -| validateXSDTypes | boolean | No | The value indicating whether to validate XSD types. | -| allowLeadingAndTrailingSpacesAndZeroes | boolean | No | The value indicating whether to allow leading and trailing spaces and zeroes. | -| validateCharacterSet | boolean | No | The value indicating whether to validate character Set. | -| trimLeadingAndTrailingSpacesAndZeroes | boolean | No | The value indicating whether to trim leading and trailing spaces and zeroes. | -| trailingSeparatorPolicy | enum | No | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory | - - - -### X12MessageIdentifier object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id. | - - - -### X12SchemaReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id. | -| senderApplicationId | string | No | The sender application id. | -| schemaVersion | string | No | The schema version. | -| schemaName | string | No | The schema name. | - - - -### X12DelimiterOverrides object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocolVersion | string | No | The protocol version. | -| messageId | string | No | The message id. | -| dataElementSeparator | integer | No | The data element separator. | -| componentSeparator | integer | No | The component separator. | -| segmentTerminator | integer | No | The segment terminator. | -| segmentTerminatorSuffix | enum | No | The segment terminator suffix. - NotSpecified, None, CR, LF, CRLF | -| replaceCharacter | integer | No | The replacement character. | -| replaceSeparatorsInPayload | boolean | No | The value indicating whether to replace separators in payload. | -| targetNamespace | string | No | The target namespace on which this delimiter settings has to be applied. | - - - -### EdifactValidationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| validateCharacterSet | boolean | No | The value indicating whether to validate character set in the message. | -| checkDuplicateInterchangeControlNumber | boolean | No | The value indicating whether to check for duplicate interchange control number. | -| interchangeControlNumberValidityDays | integer | No | The validity period of interchange control number. | -| checkDuplicateGroupControlNumber | boolean | No | The value indicating whether to check for duplicate group control number. | -| checkDuplicateTransactionSetControlNumber | boolean | No | The value indicating whether to check for duplicate transaction set control number. | -| validateEDITypes | boolean | No | The value indicating whether to Whether to validate EDI types. | -| validateXSDTypes | boolean | No | The value indicating whether to Whether to validate XSD types. | -| allowLeadingAndTrailingSpacesAndZeroes | boolean | No | The value indicating whether to allow leading and trailing spaces and zeroes. | -| trimLeadingAndTrailingSpacesAndZeroes | boolean | No | The value indicating whether to trim leading and trailing spaces and zeroes. | -| trailingSeparatorPolicy | enum | No | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory | - - - -### EdifactFramingSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceCodeListDirectoryVersion | string | No | The service code list directory version. | -| characterEncoding | string | No | The character encoding. | -| protocolVersion | integer | No | The protocol version. | -| dataElementSeparator | integer | No | The data element separator. | -| componentSeparator | integer | No | The component separator. | -| segmentTerminator | integer | No | The segment terminator. | -| releaseIndicator | integer | No | The release indicator. | -| repetitionSeparator | integer | No | The repetition separator. | -| characterSet | enum | No | The EDIFACT frame setting characterSet. - NotSpecified, UNOB, UNOA, UNOC, UNOD, UNOE, UNOF, UNOG, UNOH, UNOI, UNOJ, UNOK, UNOX, UNOY, KECA | -| decimalPointIndicator | enum | No | The EDIFACT frame setting decimal indicator. - NotSpecified, Comma, Decimal | -| segmentTerminatorSuffix | enum | No | The EDIFACT frame setting segment terminator suffix. - NotSpecified, None, CR, LF, CRLF | - - - -### EdifactEnvelopeSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| groupAssociationAssignedCode | string | No | The group association assigned code. | -| communicationAgreementId | string | No | The communication agreement id. | -| applyDelimiterStringAdvice | boolean | No | The value indicating whether to apply delimiter string advice. | -| createGroupingSegments | boolean | No | The value indicating whether to create grouping segments. | -| enableDefaultGroupHeaders | boolean | No | The value indicating whether to enable default group headers. | -| recipientReferencePasswordValue | string | No | The recipient reference password value. | -| recipientReferencePasswordQualifier | string | No | The recipient reference password qualifier. | -| applicationReferenceId | string | No | The application reference id. | -| processingPriorityCode | string | No | The processing priority code. | -| interchangeControlNumberLowerBound | integer | No | The interchange control number lower bound. | -| interchangeControlNumberUpperBound | integer | No | The interchange control number upper bound. | -| rolloverInterchangeControlNumber | boolean | No | The value indicating whether to rollover interchange control number. | -| interchangeControlNumberPrefix | string | No | The interchange control number prefix. | -| interchangeControlNumberSuffix | string | No | The interchange control number suffix. | -| senderReverseRoutingAddress | string | No | The sender reverse routing address. | -| receiverReverseRoutingAddress | string | No | The receiver reverse routing address. | -| functionalGroupId | string | No | The functional group id. | -| groupControllingAgencyCode | string | No | The group controlling agency code. | -| groupMessageVersion | string | No | The group message version. | -| groupMessageRelease | string | No | The group message release. | -| groupControlNumberLowerBound | integer | No | The group control number lower bound. | -| groupControlNumberUpperBound | integer | No | The group control number upper bound. | -| rolloverGroupControlNumber | boolean | No | The value indicating whether to rollover group control number. | -| groupControlNumberPrefix | string | No | The group control number prefix. | -| groupControlNumberSuffix | string | No | The group control number suffix. | -| groupApplicationReceiverQualifier | string | No | The group application receiver qualifier. | -| groupApplicationReceiverId | string | No | The group application receiver id. | -| groupApplicationSenderQualifier | string | No | The group application sender qualifier. | -| groupApplicationSenderId | string | No | The group application sender id. | -| groupApplicationPassword | string | No | The group application password. | -| overwriteExistingTransactionSetControlNumber | boolean | No | The value indicating whether to overwrite existing transaction set control number. | -| transactionSetControlNumberPrefix | string | No | The transaction set control number prefix. | -| transactionSetControlNumberSuffix | string | No | The transaction set control number suffix. | -| transactionSetControlNumberLowerBound | integer | No | The transaction set control number lower bound. | -| transactionSetControlNumberUpperBound | integer | No | The transaction set control number upper bound. | -| rolloverTransactionSetControlNumber | boolean | No | The value indicating whether to rollover transaction set control number. | -| isTestInterchange | boolean | No | The value indicating whether the message is a test interchange. | -| senderInternalIdentification | string | No | The sender internal identification. | -| senderInternalSubIdentification | string | No | The sender internal sub identification. | -| receiverInternalIdentification | string | No | The receiver internal identification. | -| receiverInternalSubIdentification | string | No | The receiver internal sub identification. | - - - -### EdifactAcknowledgementSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| needTechnicalAcknowledgement | boolean | No | The value indicating whether technical acknowledgement is needed. | -| batchTechnicalAcknowledgements | boolean | No | The value indicating whether to batch the technical acknowledgements. | -| needFunctionalAcknowledgement | boolean | No | The value indicating whether functional acknowledgement is needed. | -| batchFunctionalAcknowledgements | boolean | No | The value indicating whether to batch functional acknowledgements. | -| needLoopForValidMessages | boolean | No | The value indicating whether a loop is needed for valid messages. | -| sendSynchronousAcknowledgement | boolean | No | The value indicating whether to send synchronous acknowledgement. | -| acknowledgementControlNumberPrefix | string | No | The acknowledgement control number prefix. | -| acknowledgementControlNumberSuffix | string | No | The acknowledgement control number suffix. | -| acknowledgementControlNumberLowerBound | integer | No | The acknowledgement control number lower bound. | -| acknowledgementControlNumberUpperBound | integer | No | The acknowledgement control number upper bound. | -| rolloverAcknowledgementControlNumber | boolean | No | The value indicating whether to rollover acknowledgement control number. | - - - -### EdifactMessageFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageFilterType | enum | No | The message filter type. - NotSpecified, Include, Exclude | - - - -### EdifactProcessingSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maskSecurityInfo | boolean | No | The value indicating whether to mask security information. | -| preserveInterchange | boolean | No | The value indicating whether to preserve interchange. | -| suspendInterchangeOnError | boolean | No | The value indicating whether to suspend interchange on error. | -| createEmptyXmlTagsForTrailingSeparators | boolean | No | The value indicating whether to create empty xml tags for trailing separators. | -| useDotAsDecimalSeparator | boolean | No | The value indicating whether to use dot as decimal separator. | - - - -### EdifactEnvelopeOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id on which this envelope settings has to be applied. | -| messageVersion | string | No | The message version on which this envelope settings has to be applied. | -| messageRelease | string | No | The message release version on which this envelope settings has to be applied. | -| messageAssociationAssignedCode | string | No | The message association assigned code. | -| targetNamespace | string | No | The target namespace on which this envelope settings has to be applied. | -| functionalGroupId | string | No | The functional group id. | -| senderApplicationQualifier | string | No | The sender application qualifier. | -| senderApplicationId | string | No | The sender application id. | -| receiverApplicationQualifier | string | No | The receiver application qualifier. | -| receiverApplicationId | string | No | The receiver application id. | -| controllingAgencyCode | string | No | The controlling agency code. | -| groupHeaderMessageVersion | string | No | The group header message version. | -| groupHeaderMessageRelease | string | No | The group header message release. | -| associationAssignedCode | string | No | The association assigned code. | -| applicationPassword | string | No | The application password. | - - - -### EdifactMessageIdentifier object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id on which this envelope settings has to be applied. | - - - -### EdifactSchemaReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id. | -| messageVersion | string | No | The message version. | -| messageRelease | string | No | The message release version. | -| senderApplicationId | string | No | The sender application id. | -| senderApplicationQualifier | string | No | The sender application qualifier. | -| associationAssignedCode | string | No | The association assigned code. | -| schemaName | string | No | The schema name. | - - - -### EdifactValidationOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id on which the validation settings has to be applied. | -| enforceCharacterSet | boolean | No | The value indicating whether to validate character Set. | -| validateEDITypes | boolean | No | The value indicating whether to validate EDI types. | -| validateXSDTypes | boolean | No | The value indicating whether to validate XSD types. | -| allowLeadingAndTrailingSpacesAndZeroes | boolean | No | The value indicating whether to allow leading and trailing spaces and zeroes. | -| trailingSeparatorPolicy | enum | No | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory | -| trimLeadingAndTrailingSpacesAndZeroes | boolean | No | The value indicating whether to trim leading and trailing spaces and zeroes. | - - - -### EdifactDelimiterOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id. | -| messageVersion | string | No | The message version. | -| messageRelease | string | No | The message releaseversion. | -| dataElementSeparator | integer | No | The data element separator. | -| componentSeparator | integer | No | The component separator. | -| segmentTerminator | integer | No | The segment terminator. | -| repetitionSeparator | integer | No | The repetition separator. | -| segmentTerminatorSuffix | enum | No | The segment terminator suffix. - NotSpecified, None, CR, LF, CRLF | -| decimalPointIndicator | enum | No | The decimal point indicator. - NotSpecified, Comma, Decimal | -| releaseIndicator | integer | No | The release indicator. | -| messageAssociationAssignedCode | string | No | The message association assigned code. | -| targetNamespace | string | No | The target namespace on which this delimiter settings has to be applied. | - diff --git a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/certificates.md b/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/certificates.md deleted file mode 100644 index ca5e185..0000000 --- a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/certificates.md +++ /dev/null @@ -1,68 +0,0 @@ -# Microsoft.Logic/integrationAccounts/certificates template reference -API Version: 2015-08-01-preview -## Template format - -To create a Microsoft.Logic/integrationAccounts/certificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/certificates", - "apiVersion": "2015-08-01-preview", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "metadata": {}, - "key": { - "keyVault": { - "id": "string" - }, - "keyName": "string", - "keyVersion": "string" - }, - "publicCertificate": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/certificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/certificates | -| apiVersion | enum | Yes | 2015-08-01-preview | -| id | string | No | The resource id. | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account certificate properties. - [IntegrationAccountCertificateProperties object](#IntegrationAccountCertificateProperties) | - - - -### IntegrationAccountCertificateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| metadata | object | No | The metadata. | -| key | object | No | The key details in the key vault. - [KeyVaultKeyReference object](#KeyVaultKeyReference) | -| publicCertificate | string | No | The public certificate. | - - - -### KeyVaultKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyVault | object | No | The key vault reference. - [KeyVaultKeyReferenceKeyVault object](#KeyVaultKeyReferenceKeyVault) | -| keyName | string | No | The private key name in key vault. | -| keyVersion | string | No | The private key version in key vault. | - - - -### KeyVaultKeyReferenceKeyVault object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | The resource id. | - diff --git a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/maps.md b/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/maps.md deleted file mode 100644 index e676f1a..0000000 --- a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/maps.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.Logic/integrationAccounts/maps template reference -API Version: 2015-08-01-preview -## Template format - -To create a Microsoft.Logic/integrationAccounts/maps resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/maps", - "apiVersion": "2015-08-01-preview", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "mapType": "string", - "content": {}, - "contentType": "string", - "metadata": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/maps object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/maps | -| apiVersion | enum | Yes | 2015-08-01-preview | -| id | string | No | The resource id. | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account map properties. - [IntegrationAccountMapProperties object](#IntegrationAccountMapProperties) | - - - -### IntegrationAccountMapProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| mapType | enum | No | The map type. - NotSpecified or Xslt | -| content | object | No | The content. | -| contentType | string | No | The content type. | -| metadata | object | No | The metadata. | - diff --git a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/partners.md b/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/partners.md deleted file mode 100644 index 468a7d1..0000000 --- a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/partners.md +++ /dev/null @@ -1,77 +0,0 @@ -# Microsoft.Logic/integrationAccounts/partners template reference -API Version: 2015-08-01-preview -## Template format - -To create a Microsoft.Logic/integrationAccounts/partners resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/partners", - "apiVersion": "2015-08-01-preview", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "partnerType": "string", - "metadata": {}, - "content": { - "b2b": { - "businessIdentities": [ - { - "Qualifier": "string", - "Value": "string" - } - ] - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/partners object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/partners | -| apiVersion | enum | Yes | 2015-08-01-preview | -| id | string | No | The resource id. | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account partner properties. - [IntegrationAccountPartnerProperties object](#IntegrationAccountPartnerProperties) | - - - -### IntegrationAccountPartnerProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| partnerType | enum | No | The partner type. - NotSpecified or B2B | -| metadata | object | No | The metadata. | -| content | object | No | The partner content. - [PartnerContent object](#PartnerContent) | - - - -### PartnerContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| b2b | object | No | The B2B partner content. - [B2BPartnerContent object](#B2BPartnerContent) | - - - -### B2BPartnerContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| businessIdentities | array | No | The list of partner business identities. - [BusinessIdentity object](#BusinessIdentity) | - - - -### BusinessIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| Qualifier | string | No | The business identity qualifier. | -| Value | string | No | The business identity value. | - diff --git a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/schemas.md b/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/schemas.md deleted file mode 100644 index bd197a3..0000000 --- a/test/Resource/Expected/Logic/2015-08-01-preview/integrationAccounts/schemas.md +++ /dev/null @@ -1,50 +0,0 @@ -# Microsoft.Logic/integrationAccounts/schemas template reference -API Version: 2015-08-01-preview -## Template format - -To create a Microsoft.Logic/integrationAccounts/schemas resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/schemas", - "apiVersion": "2015-08-01-preview", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "schemaType": "string", - "targetNamespace": "string", - "content": {}, - "contentType": "string", - "metadata": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/schemas object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/schemas | -| apiVersion | enum | Yes | 2015-08-01-preview | -| id | string | No | The resource id. | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account schema properties. - [IntegrationAccountSchemaProperties object](#IntegrationAccountSchemaProperties) | - - - -### IntegrationAccountSchemaProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| schemaType | enum | No | The schema type. - NotSpecified or Xml | -| targetNamespace | string | No | The target namespace. | -| content | object | No | The content. | -| contentType | string | No | The content type. | -| metadata | object | No | The metadata. | - diff --git a/test/Resource/Expected/Logic/2016-06-01/Microsoft.Logic.json b/test/Resource/Expected/Logic/2016-06-01/Microsoft.Logic.json deleted file mode 100644 index 3e48df3..0000000 --- a/test/Resource/Expected/Logic/2016-06-01/Microsoft.Logic.json +++ /dev/null @@ -1,4808 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-06-01/Microsoft.Logic.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Logic", - "description": "Microsoft Logic Resource Types", - "resourceDefinitions": { - "integrationAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "type": "object", - "properties": {}, - "description": "The integration account properties." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sku." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/integrationAccounts_schemas_childResource" - }, - { - "$ref": "#/definitions/integrationAccounts_maps_childResource" - }, - { - "$ref": "#/definitions/integrationAccounts_partners_childResource" - }, - { - "$ref": "#/definitions/integrationAccounts_agreements_childResource" - }, - { - "$ref": "#/definitions/integrationAccounts_certificates_childResource" - }, - { - "$ref": "#/definitions/integrationAccounts_sessions_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts" - }, - "integrationAccounts_agreements": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/agreements" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountAgreementProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account agreement properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/agreements" - }, - "integrationAccounts_certificates": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountCertificateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account certificate properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/certificates" - }, - "integrationAccounts_maps": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/maps" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountMapProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account map properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/maps" - }, - "integrationAccounts_partners": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/partners" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountPartnerProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account partner properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/partners" - }, - "integrationAccounts_schemas": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/schemas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountSchemaProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account schema properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/schemas" - }, - "integrationAccounts_sessions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/integrationAccounts/sessions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountSessionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account session properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/sessions" - }, - "workflows": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Logic/workflows" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WorkflowProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The workflow properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/workflows" - } - }, - "definitions": { - "AgreementContent": { - "type": "object", - "properties": { - "aS2": { - "oneOf": [ - { - "$ref": "#/definitions/AS2AgreementContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AS2 agreement content." - }, - "x12": { - "oneOf": [ - { - "$ref": "#/definitions/X12AgreementContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 agreement content." - }, - "edifact": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactAgreementContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT agreement content." - } - }, - "description": "The integration account agreement content." - }, - "AS2AcknowledgementConnectionSettings": { - "type": "object", - "properties": { - "ignoreCertificateNameMismatch": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to ignore mismatch in certificate name." - }, - "supportHttpStatusCodeContinue": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to support HTTP status code 'CONTINUE'." - }, - "keepHttpConnectionAlive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to keep the connection alive." - }, - "unfoldHttpHeaders": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to unfold the HTTP headers." - } - }, - "required": [ - "ignoreCertificateNameMismatch", - "supportHttpStatusCodeContinue", - "keepHttpConnectionAlive", - "unfoldHttpHeaders" - ], - "description": "The AS2 agreement acknowledegment connection settings." - }, - "AS2AgreementContent": { - "type": "object", - "properties": { - "receiveAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/AS2OneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AS2 one-way receive agreement." - }, - "sendAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/AS2OneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AS2 one-way send agreement." - } - }, - "required": [ - "receiveAgreement", - "sendAgreement" - ], - "description": "The integration account AS2 agreement content." - }, - "AS2EnvelopeSettings": { - "type": "object", - "properties": { - "messageContentType": { - "type": "string", - "description": "The message content type." - }, - "transmitFileNameInMimeHeader": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to transmit file name in mime header." - }, - "fileNameTemplate": { - "type": "string", - "description": "The template for file name." - }, - "suspendMessageOnFileNameGenerationError": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to suspend message on file name generation error." - }, - "autogenerateFileName": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to auto generate file name." - } - }, - "required": [ - "messageContentType", - "transmitFileNameInMimeHeader", - "fileNameTemplate", - "suspendMessageOnFileNameGenerationError", - "autogenerateFileName" - ], - "description": "The AS2 agreement envelope settings." - }, - "AS2ErrorSettings": { - "type": "object", - "properties": { - "suspendDuplicateMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to suspend duplicate message." - }, - "resendIfMdnNotReceived": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to resend message If MDN is not received." - } - }, - "required": [ - "suspendDuplicateMessage", - "resendIfMdnNotReceived" - ], - "description": "The AS2 agreement error settings." - }, - "AS2MdnSettings": { - "type": "object", - "properties": { - "needMdn": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send or request a MDN." - }, - "signMdn": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the MDN needs to be signed or not." - }, - "sendMdnAsynchronously": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send the asynchronous MDN." - }, - "receiptDeliveryUrl": { - "type": "string", - "description": "The receipt delivery URL." - }, - "dispositionNotificationTo": { - "type": "string", - "description": "The disposition notification to header value." - }, - "signOutboundMdnIfOptional": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to sign the outbound MDN if optional." - }, - "mdnText": { - "type": "string", - "description": "The MDN text." - }, - "sendInboundMdnToMessageBox": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send inbound MDN to message box." - }, - "micHashingAlgorithm": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "MD5", - "SHA1", - "SHA2256", - "SHA2384", - "SHA2512" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The signing or hashing algorithm." - } - }, - "required": [ - "needMdn", - "signMdn", - "sendMdnAsynchronously", - "signOutboundMdnIfOptional", - "sendInboundMdnToMessageBox", - "micHashingAlgorithm" - ], - "description": "The AS2 agreement mdn settings." - }, - "AS2MessageConnectionSettings": { - "type": "object", - "properties": { - "ignoreCertificateNameMismatch": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to ignore mismatch in certificate name." - }, - "supportHttpStatusCodeContinue": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to support HTTP status code 'CONTINUE'." - }, - "keepHttpConnectionAlive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to keep the connection alive." - }, - "unfoldHttpHeaders": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to unfold the HTTP headers." - } - }, - "required": [ - "ignoreCertificateNameMismatch", - "supportHttpStatusCodeContinue", - "keepHttpConnectionAlive", - "unfoldHttpHeaders" - ], - "description": "The AS2 agreement message connection settings." - }, - "AS2OneWayAgreement": { - "type": "object", - "properties": { - "senderBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sender business identity" - }, - "receiverBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The receiver business identity" - }, - "protocolSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2ProtocolSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AS2 protocol settings." - } - }, - "required": [ - "senderBusinessIdentity", - "receiverBusinessIdentity", - "protocolSettings" - ], - "description": "The integration account AS2 oneway agreement." - }, - "AS2ProtocolSettings": { - "type": "object", - "properties": { - "messageConnectionSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2MessageConnectionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The message connection settings." - }, - "acknowledgementConnectionSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2AcknowledgementConnectionSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement connection settings." - }, - "mdnSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2MdnSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The MDN settings." - }, - "securitySettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2SecuritySettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The security settings." - }, - "validationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2ValidationSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The validation settings." - }, - "envelopeSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2EnvelopeSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The envelope settings." - }, - "errorSettings": { - "oneOf": [ - { - "$ref": "#/definitions/AS2ErrorSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The error settings." - } - }, - "required": [ - "messageConnectionSettings", - "acknowledgementConnectionSettings", - "mdnSettings", - "securitySettings", - "validationSettings", - "envelopeSettings", - "errorSettings" - ], - "description": "The AS2 agreement protocol settings." - }, - "AS2SecuritySettings": { - "type": "object", - "properties": { - "overrideGroupSigningCertificate": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send or request a MDN." - }, - "signingCertificateName": { - "type": "string", - "description": "The name of the signing certificate." - }, - "encryptionCertificateName": { - "type": "string", - "description": "The name of the encryption certificate." - }, - "enableNrrForInboundEncodedMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for inbound encoded messages." - }, - "enableNrrForInboundDecodedMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for inbound decoded messages." - }, - "enableNrrForOutboundMdn": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for outbound MDN." - }, - "enableNrrForOutboundEncodedMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for outbound encoded messages." - }, - "enableNrrForOutboundDecodedMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for outbound decoded messages." - }, - "enableNrrForInboundMdn": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable NRR for inbound MDN." - }, - "sha2AlgorithmFormat": { - "type": "string", - "description": "The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize." - } - }, - "required": [ - "overrideGroupSigningCertificate", - "enableNrrForInboundEncodedMessages", - "enableNrrForInboundDecodedMessages", - "enableNrrForOutboundMdn", - "enableNrrForOutboundEncodedMessages", - "enableNrrForOutboundDecodedMessages", - "enableNrrForInboundMdn" - ], - "description": "The AS2 agreement security settings." - }, - "AS2ValidationSettings": { - "type": "object", - "properties": { - "overrideMessageProperties": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to override incoming message properties with those in agreement." - }, - "encryptMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the message has to be encrypted." - }, - "signMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the message has to be signed." - }, - "compressMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the message has to be compressed." - }, - "checkDuplicateMessage": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate message." - }, - "interchangeDuplicatesValidityDays": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of days to look back for duplicate interchange." - }, - "checkCertificateRevocationListOnSend": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for certificate revocation list on send." - }, - "checkCertificateRevocationListOnReceive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for certificate revocation list on receive." - }, - "encryptionAlgorithm": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "DES3", - "RC2", - "AES128", - "AES192", - "AES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption algorithm." - }, - "signingAlgorithm": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Default", - "SHA1", - "SHA2256", - "SHA2384", - "SHA2512" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The signing algorithm." - } - }, - "required": [ - "overrideMessageProperties", - "encryptMessage", - "signMessage", - "compressMessage", - "checkDuplicateMessage", - "interchangeDuplicatesValidityDays", - "checkCertificateRevocationListOnSend", - "checkCertificateRevocationListOnReceive", - "encryptionAlgorithm" - ], - "description": "The AS2 agreement validation settings." - }, - "B2BPartnerContent": { - "type": "object", - "properties": { - "businessIdentities": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BusinessIdentity" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of partner business identities." - } - }, - "description": "The B2B partner content." - }, - "BusinessIdentity": { - "type": "object", - "properties": { - "qualifier": { - "type": "string", - "description": "The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32" - }, - "value": { - "type": "string", - "description": "The user defined business identity value." - } - }, - "required": [ - "qualifier", - "value" - ], - "description": "The integration account partner's business identity." - }, - "EdifactAcknowledgementSettings": { - "type": "object", - "properties": { - "needTechnicalAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether technical acknowledgement is needed." - }, - "batchTechnicalAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch the technical acknowledgements." - }, - "needFunctionalAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether functional acknowledgement is needed." - }, - "batchFunctionalAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch functional acknowledgements." - }, - "needLoopForValidMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether a loop is needed for valid messages." - }, - "sendSynchronousAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send synchronous acknowledgement." - }, - "acknowledgementControlNumberPrefix": { - "type": "string", - "description": "The acknowledgement control number prefix." - }, - "acknowledgementControlNumberSuffix": { - "type": "string", - "description": "The acknowledgement control number suffix." - }, - "acknowledgementControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement control number lower bound." - }, - "acknowledgementControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement control number upper bound." - }, - "rolloverAcknowledgementControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover acknowledgement control number." - } - }, - "required": [ - "needTechnicalAcknowledgement", - "batchTechnicalAcknowledgements", - "needFunctionalAcknowledgement", - "batchFunctionalAcknowledgements", - "needLoopForValidMessages", - "sendSynchronousAcknowledgement", - "acknowledgementControlNumberLowerBound", - "acknowledgementControlNumberUpperBound", - "rolloverAcknowledgementControlNumber" - ], - "description": "The Edifact agreement acknowledgement settings." - }, - "EdifactAgreementContent": { - "type": "object", - "properties": { - "receiveAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactOneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT one-way receive agreement." - }, - "sendAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactOneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT one-way send agreement." - } - }, - "required": [ - "receiveAgreement", - "sendAgreement" - ], - "description": "The Edifact agreement content." - }, - "EdifactDelimiterOverride": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id." - }, - "messageVersion": { - "type": "string", - "description": "The message version." - }, - "messageRelease": { - "type": "string", - "description": "The message releaseversion." - }, - "dataElementSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The data element separator." - }, - "componentSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component separator." - }, - "segmentTerminator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator." - }, - "repetitionSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The repetition separator." - }, - "segmentTerminatorSuffix": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "CR", - "LF", - "CRLF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator suffix." - }, - "decimalPointIndicator": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Comma", - "Decimal" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The decimal point indicator." - }, - "releaseIndicator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The release indicator." - }, - "messageAssociationAssignedCode": { - "type": "string", - "description": "The message association assigned code." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace on which this delimiter settings has to be applied." - } - }, - "required": [ - "dataElementSeparator", - "componentSeparator", - "segmentTerminator", - "repetitionSeparator", - "segmentTerminatorSuffix", - "decimalPointIndicator", - "releaseIndicator" - ], - "description": "The Edifact delimiter override settings." - }, - "EdifactEnvelopeOverride": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id on which this envelope settings has to be applied." - }, - "messageVersion": { - "type": "string", - "description": "The message version on which this envelope settings has to be applied." - }, - "messageRelease": { - "type": "string", - "description": "The message release version on which this envelope settings has to be applied." - }, - "messageAssociationAssignedCode": { - "type": "string", - "description": "The message association assigned code." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace on which this envelope settings has to be applied." - }, - "functionalGroupId": { - "type": "string", - "description": "The functional group id." - }, - "senderApplicationQualifier": { - "type": "string", - "description": "The sender application qualifier." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "receiverApplicationQualifier": { - "type": "string", - "description": "The receiver application qualifier." - }, - "receiverApplicationId": { - "type": "string", - "description": "The receiver application id." - }, - "controllingAgencyCode": { - "type": "string", - "description": "The controlling agency code." - }, - "groupHeaderMessageVersion": { - "type": "string", - "description": "The group header message version." - }, - "groupHeaderMessageRelease": { - "type": "string", - "description": "The group header message release." - }, - "associationAssignedCode": { - "type": "string", - "description": "The association assigned code." - }, - "applicationPassword": { - "type": "string", - "description": "The application password." - } - }, - "description": "The Edifact enevlope override settings." - }, - "EdifactEnvelopeSettings": { - "type": "object", - "properties": { - "groupAssociationAssignedCode": { - "type": "string", - "description": "The group association assigned code." - }, - "communicationAgreementId": { - "type": "string", - "description": "The communication agreement id." - }, - "applyDelimiterStringAdvice": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to apply delimiter string advice." - }, - "createGroupingSegments": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to create grouping segments." - }, - "enableDefaultGroupHeaders": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable default group headers." - }, - "recipientReferencePasswordValue": { - "type": "string", - "description": "The recipient reference password value." - }, - "recipientReferencePasswordQualifier": { - "type": "string", - "description": "The recipient reference password qualifier." - }, - "applicationReferenceId": { - "type": "string", - "description": "The application reference id." - }, - "processingPriorityCode": { - "type": "string", - "description": "The processing priority code." - }, - "interchangeControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interchange control number lower bound." - }, - "interchangeControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interchange control number upper bound." - }, - "rolloverInterchangeControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover interchange control number." - }, - "interchangeControlNumberPrefix": { - "type": "string", - "description": "The interchange control number prefix." - }, - "interchangeControlNumberSuffix": { - "type": "string", - "description": "The interchange control number suffix." - }, - "senderReverseRoutingAddress": { - "type": "string", - "description": "The sender reverse routing address." - }, - "receiverReverseRoutingAddress": { - "type": "string", - "description": "The receiver reverse routing address." - }, - "functionalGroupId": { - "type": "string", - "description": "The functional group id." - }, - "groupControllingAgencyCode": { - "type": "string", - "description": "The group controlling agency code." - }, - "groupMessageVersion": { - "type": "string", - "description": "The group message version." - }, - "groupMessageRelease": { - "type": "string", - "description": "The group message release." - }, - "groupControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group control number lower bound." - }, - "groupControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group control number upper bound." - }, - "rolloverGroupControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover group control number." - }, - "groupControlNumberPrefix": { - "type": "string", - "description": "The group control number prefix." - }, - "groupControlNumberSuffix": { - "type": "string", - "description": "The group control number suffix." - }, - "groupApplicationReceiverQualifier": { - "type": "string", - "description": "The group application receiver qualifier." - }, - "groupApplicationReceiverId": { - "type": "string", - "description": "The group application receiver id." - }, - "groupApplicationSenderQualifier": { - "type": "string", - "description": "The group application sender qualifier." - }, - "groupApplicationSenderId": { - "type": "string", - "description": "The group application sender id." - }, - "groupApplicationPassword": { - "type": "string", - "description": "The group application password." - }, - "overwriteExistingTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to overwrite existing transaction set control number." - }, - "transactionSetControlNumberPrefix": { - "type": "string", - "description": "The transaction set control number prefix." - }, - "transactionSetControlNumberSuffix": { - "type": "string", - "description": "The transaction set control number suffix." - }, - "transactionSetControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transaction set control number lower bound." - }, - "transactionSetControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transaction set control number upper bound." - }, - "rolloverTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover transaction set control number." - }, - "isTestInterchange": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether the message is a test interchange." - }, - "senderInternalIdentification": { - "type": "string", - "description": "The sender internal identification." - }, - "senderInternalSubIdentification": { - "type": "string", - "description": "The sender internal sub identification." - }, - "receiverInternalIdentification": { - "type": "string", - "description": "The receiver internal identification." - }, - "receiverInternalSubIdentification": { - "type": "string", - "description": "The receiver internal sub identification." - } - }, - "required": [ - "applyDelimiterStringAdvice", - "createGroupingSegments", - "enableDefaultGroupHeaders", - "interchangeControlNumberLowerBound", - "interchangeControlNumberUpperBound", - "rolloverInterchangeControlNumber", - "groupControlNumberLowerBound", - "groupControlNumberUpperBound", - "rolloverGroupControlNumber", - "overwriteExistingTransactionSetControlNumber", - "transactionSetControlNumberLowerBound", - "transactionSetControlNumberUpperBound", - "rolloverTransactionSetControlNumber", - "isTestInterchange" - ], - "description": "The Edifact agreement envelope settings." - }, - "EdifactFramingSettings": { - "type": "object", - "properties": { - "serviceCodeListDirectoryVersion": { - "type": "string", - "description": "The service code list directory version." - }, - "characterEncoding": { - "type": "string", - "description": "The character encoding." - }, - "protocolVersion": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The protocol version." - }, - "dataElementSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The data element separator." - }, - "componentSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component separator." - }, - "segmentTerminator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator." - }, - "releaseIndicator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The release indicator." - }, - "repetitionSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The repetition separator." - }, - "characterSet": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "UNOB", - "UNOA", - "UNOC", - "UNOD", - "UNOE", - "UNOF", - "UNOG", - "UNOH", - "UNOI", - "UNOJ", - "UNOK", - "UNOX", - "UNOY", - "KECA" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT frame setting characterSet." - }, - "decimalPointIndicator": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Comma", - "Decimal" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT frame setting decimal indicator." - }, - "segmentTerminatorSuffix": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "CR", - "LF", - "CRLF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT frame setting segment terminator suffix." - } - }, - "required": [ - "protocolVersion", - "dataElementSeparator", - "componentSeparator", - "segmentTerminator", - "releaseIndicator", - "repetitionSeparator", - "characterSet", - "decimalPointIndicator", - "segmentTerminatorSuffix" - ], - "description": "The Edifact agreement framing settings." - }, - "EdifactMessageFilter": { - "type": "object", - "properties": { - "messageFilterType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Include", - "Exclude" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The message filter type." - } - }, - "required": [ - "messageFilterType" - ], - "description": "The Edifact message filter for odata query." - }, - "EdifactMessageIdentifier": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id on which this envelope settings has to be applied." - } - }, - "required": [ - "messageId" - ], - "description": "The Edifact message identifier." - }, - "EdifactOneWayAgreement": { - "type": "object", - "properties": { - "senderBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sender business identity" - }, - "receiverBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The receiver business identity" - }, - "protocolSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactProtocolSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT protocol settings." - } - }, - "required": [ - "senderBusinessIdentity", - "receiverBusinessIdentity", - "protocolSettings" - ], - "description": "The Edifact one way agreement." - }, - "EdifactProcessingSettings": { - "type": "object", - "properties": { - "maskSecurityInfo": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to mask security information." - }, - "preserveInterchange": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to preserve interchange." - }, - "suspendInterchangeOnError": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to suspend interchange on error." - }, - "createEmptyXmlTagsForTrailingSeparators": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to create empty xml tags for trailing separators." - }, - "useDotAsDecimalSeparator": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to use dot as decimal separator." - } - }, - "required": [ - "maskSecurityInfo", - "preserveInterchange", - "suspendInterchangeOnError", - "createEmptyXmlTagsForTrailingSeparators", - "useDotAsDecimalSeparator" - ], - "description": "The Edifact agreement protocol settings." - }, - "EdifactProtocolSettings": { - "type": "object", - "properties": { - "validationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactValidationSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT validation settings." - }, - "framingSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactFramingSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT framing settings." - }, - "envelopeSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactEnvelopeSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT envelope settings." - }, - "acknowledgementSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactAcknowledgementSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT acknowledgement settings." - }, - "messageFilter": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactMessageFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT message filter." - }, - "processingSettings": { - "oneOf": [ - { - "$ref": "#/definitions/EdifactProcessingSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT processing Settings." - }, - "envelopeOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactEnvelopeOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT envelope override settings." - }, - "messageFilterList": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactMessageIdentifier" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT message filter list." - }, - "schemaReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactSchemaReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT schema references." - }, - "validationOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactValidationOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT validation override settings." - }, - "edifactDelimiterOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactDelimiterOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The EDIFACT delimiter override settings." - } - }, - "required": [ - "validationSettings", - "framingSettings", - "envelopeSettings", - "acknowledgementSettings", - "messageFilter", - "processingSettings", - "schemaReferences" - ], - "description": "The Edifact agreement protocol settings." - }, - "EdifactSchemaReference": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id." - }, - "messageVersion": { - "type": "string", - "description": "The message version." - }, - "messageRelease": { - "type": "string", - "description": "The message release version." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "senderApplicationQualifier": { - "type": "string", - "description": "The sender application qualifier." - }, - "associationAssignedCode": { - "type": "string", - "description": "The association assigned code." - }, - "schemaName": { - "type": "string", - "description": "The schema name." - } - }, - "required": [ - "messageId", - "messageVersion", - "messageRelease", - "schemaName" - ], - "description": "The Edifact schema reference." - }, - "EdifactValidationOverride": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id on which the validation settings has to be applied." - }, - "enforceCharacterSet": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate character Set." - }, - "validateEdiTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate EDI types." - }, - "validateXsdTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate XSD types." - }, - "allowLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." - }, - "trailingSeparatorPolicy": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "NotAllowed", - "Optional", - "Mandatory" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The trailing separator policy." - }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." - } - }, - "required": [ - "messageId", - "enforceCharacterSet", - "validateEdiTypes", - "validateXsdTypes", - "allowLeadingAndTrailingSpacesAndZeroes", - "trailingSeparatorPolicy", - "trimLeadingAndTrailingSpacesAndZeroes" - ], - "description": "The Edifact validation override settings." - }, - "EdifactValidationSettings": { - "type": "object", - "properties": { - "validateCharacterSet": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate character set in the message." - }, - "checkDuplicateInterchangeControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate interchange control number." - }, - "interchangeControlNumberValidityDays": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The validity period of interchange control number." - }, - "checkDuplicateGroupControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate group control number." - }, - "checkDuplicateTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate transaction set control number." - }, - "validateEdiTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to Whether to validate EDI types." - }, - "validateXsdTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to Whether to validate XSD types." - }, - "allowLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." - }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." - }, - "trailingSeparatorPolicy": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "NotAllowed", - "Optional", - "Mandatory" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The trailing separator policy." - } - }, - "required": [ - "validateCharacterSet", - "checkDuplicateInterchangeControlNumber", - "interchangeControlNumberValidityDays", - "checkDuplicateGroupControlNumber", - "checkDuplicateTransactionSetControlNumber", - "validateEdiTypes", - "validateXsdTypes", - "allowLeadingAndTrailingSpacesAndZeroes", - "trimLeadingAndTrailingSpacesAndZeroes", - "trailingSeparatorPolicy" - ], - "description": "The Edifact agreement validation settings." - }, - "IntegrationAccountAgreementProperties": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - }, - "agreementType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "AS2", - "X12", - "Edifact" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The agreement type." - }, - "hostPartner": { - "type": "string", - "description": "The integration account partner that is set as host partner for this agreement." - }, - "guestPartner": { - "type": "string", - "description": "The integration account partner that is set as guest partner for this agreement." - }, - "hostIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The business identity of the host partner." - }, - "guestIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The business identity of the guest partner." - }, - "content": { - "oneOf": [ - { - "$ref": "#/definitions/AgreementContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The agreement content." - } - }, - "required": [ - "agreementType", - "hostPartner", - "guestPartner", - "hostIdentity", - "guestIdentity", - "content" - ], - "description": "The integration account agreement properties." - }, - "IntegrationAccountCertificateProperties": { - "type": "object", - "properties": { - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - }, - "key": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultKeyReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The key details in the key vault." - }, - "publicCertificate": { - "type": "string", - "description": "The public certificate." - } - }, - "description": "The integration account certificate properties." - }, - "IntegrationAccountMapProperties": { - "type": "object", - "properties": { - "mapType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Xslt" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The map type." - }, - "parametersSchema": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountMapPropertiesParametersSchema" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The parameters schema of integration account map." - }, - "content": { - "type": "string", - "description": "The content." - }, - "contentType": { - "type": "string", - "description": "The content type." - }, - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - } - }, - "required": [ - "mapType" - ], - "description": "The integration account map." - }, - "IntegrationAccountMapPropertiesParametersSchema": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The reference name." - } - }, - "description": "The parameters schema of integration account map." - }, - "IntegrationAccountPartnerProperties": { - "type": "object", - "properties": { - "partnerType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "B2B" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The partner type." - }, - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - }, - "content": { - "oneOf": [ - { - "$ref": "#/definitions/PartnerContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The partner content." - } - }, - "required": [ - "partnerType", - "content" - ], - "description": "The integration account partner properties." - }, - "IntegrationAccountSchemaProperties": { - "type": "object", - "properties": { - "schemaType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Xml" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The schema type." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace of the schema." - }, - "documentName": { - "type": "string", - "description": "The document name." - }, - "fileName": { - "type": "string", - "description": "The file name." - }, - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - }, - "content": { - "type": "string", - "description": "The content." - }, - "contentType": { - "type": "string", - "description": "The content type." - } - }, - "required": [ - "schemaType" - ], - "description": "The integration account schema properties." - }, - "IntegrationAccountSessionProperties": { - "type": "object", - "properties": { - "content": { - "type": "object", - "properties": {}, - "description": "The session content." - } - }, - "description": "The integration account session properties." - }, - "IntegrationAccountSku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Free", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sku name." - } - }, - "required": [ - "name" - ], - "description": "The integration account sku." - }, - "integrationAccounts_agreements_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "agreements" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountAgreementProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account agreement properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/agreements" - }, - "integrationAccounts_certificates_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountCertificateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account certificate properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/certificates" - }, - "integrationAccounts_maps_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "maps" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountMapProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account map properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/maps" - }, - "integrationAccounts_partners_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "partners" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountPartnerProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account partner properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/partners" - }, - "integrationAccounts_schemas_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "schemas" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountSchemaProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account schema properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/schemas" - }, - "integrationAccounts_sessions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "sessions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "location": { - "type": "string", - "description": "The resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IntegrationAccountSessionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account session properties." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Logic/integrationAccounts/sessions" - }, - "KeyVaultKeyReference": { - "type": "object", - "properties": { - "keyVault": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultKeyReferenceKeyVault" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The key vault reference." - }, - "keyName": { - "type": "string", - "description": "The private key name in key vault." - }, - "keyVersion": { - "type": "string", - "description": "The private key version in key vault." - } - }, - "required": [ - "keyVault", - "keyName" - ], - "description": "The reference to the key vault key." - }, - "KeyVaultKeyReferenceKeyVault": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The resource id." - } - }, - "description": "The key vault reference." - }, - "PartnerContent": { - "type": "object", - "properties": { - "b2b": { - "oneOf": [ - { - "$ref": "#/definitions/B2BPartnerContent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The B2B partner content." - } - }, - "description": "The integration account partner content." - }, - "ResourceReference": { - "type": "object", - "properties": {}, - "description": "The resource reference." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Free", - "Shared", - "Basic", - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name." - }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to plan." - } - }, - "required": [ - "name" - ], - "description": "The sku type." - }, - "WorkflowParameter": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "String", - "SecureString", - "Int", - "Float", - "Bool", - "Array", - "Object", - "SecureObject" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type." - }, - "value": { - "type": "object", - "properties": {}, - "description": "The value." - }, - "metadata": { - "type": "object", - "properties": {}, - "description": "The metadata." - }, - "description": { - "type": "string", - "description": "The description." - } - }, - "description": "The workflow parameters." - }, - "WorkflowProperties": { - "type": "object", - "properties": { - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Completed", - "Enabled", - "Disabled", - "Deleted", - "Suspended" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sku." - }, - "integrationAccount": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The integration account." - }, - "definition": { - "type": "object", - "properties": {}, - "description": "The definition." - }, - "parameters": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/WorkflowParameter" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The parameters." - } - }, - "description": "The workflow properties." - }, - "X12AcknowledgementSettings": { - "type": "object", - "properties": { - "needTechnicalAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether technical acknowledgement is needed." - }, - "batchTechnicalAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch the technical acknowledgements." - }, - "needFunctionalAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether functional acknowledgement is needed." - }, - "functionalAcknowledgementVersion": { - "type": "string", - "description": "The functional acknowledgement version." - }, - "batchFunctionalAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch functional acknowledgements." - }, - "needImplementationAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether implementation acknowledgement is needed." - }, - "implementationAcknowledgementVersion": { - "type": "string", - "description": "The implementation acknowledgement version." - }, - "batchImplementationAcknowledgements": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to batch implementation acknowledgements." - }, - "needLoopForValidMessages": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether a loop is needed for valid messages." - }, - "sendSynchronousAcknowledgement": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to send synchronous acknowledgement." - }, - "acknowledgementControlNumberPrefix": { - "type": "string", - "description": "The acknowledgement control number prefix." - }, - "acknowledgementControlNumberSuffix": { - "type": "string", - "description": "The acknowledgement control number suffix." - }, - "acknowledgementControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement control number lower bound." - }, - "acknowledgementControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The acknowledgement control number upper bound." - }, - "rolloverAcknowledgementControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover acknowledgement control number." - } - }, - "required": [ - "needTechnicalAcknowledgement", - "batchTechnicalAcknowledgements", - "needFunctionalAcknowledgement", - "batchFunctionalAcknowledgements", - "needImplementationAcknowledgement", - "batchImplementationAcknowledgements", - "needLoopForValidMessages", - "sendSynchronousAcknowledgement", - "acknowledgementControlNumberLowerBound", - "acknowledgementControlNumberUpperBound", - "rolloverAcknowledgementControlNumber" - ], - "description": "The X12 agreement acknowledgement settings." - }, - "X12AgreementContent": { - "type": "object", - "properties": { - "receiveAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/X12OneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 one-way receive agreement." - }, - "sendAgreement": { - "oneOf": [ - { - "$ref": "#/definitions/X12OneWayAgreement" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 one-way send agreement." - } - }, - "required": [ - "receiveAgreement", - "sendAgreement" - ], - "description": "The X12 agreement content." - }, - "X12DelimiterOverrides": { - "type": "object", - "properties": { - "protocolVersion": { - "type": "string", - "description": "The protocol version." - }, - "messageId": { - "type": "string", - "description": "The message id." - }, - "dataElementSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The data element separator." - }, - "componentSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component separator." - }, - "segmentTerminator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator." - }, - "segmentTerminatorSuffix": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "CR", - "LF", - "CRLF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator suffix." - }, - "replaceCharacter": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The replacement character." - }, - "replaceSeparatorsInPayload": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to replace separators in payload." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace on which this delimiter settings has to be applied." - } - }, - "required": [ - "dataElementSeparator", - "componentSeparator", - "segmentTerminator", - "segmentTerminatorSuffix", - "replaceCharacter", - "replaceSeparatorsInPayload" - ], - "description": "The X12 delimiter override settings." - }, - "X12EnvelopeOverride": { - "type": "object", - "properties": { - "targetNamespace": { - "type": "string", - "description": "The target namespace on which this envelope settings has to be applied." - }, - "protocolVersion": { - "type": "string", - "description": "The protocol version on which this envelope settings has to be applied." - }, - "messageId": { - "type": "string", - "description": "The message id on which this envelope settings has to be applied." - }, - "responsibleAgencyCode": { - "type": "string", - "description": "The responsible agency code." - }, - "headerVersion": { - "type": "string", - "description": "The header version." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "receiverApplicationId": { - "type": "string", - "description": "The receiver application id." - }, - "functionalIdentifierCode": { - "type": "string", - "description": "The functional identifier code." - }, - "dateFormat": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "CCYYMMDD", - "YYMMDD" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The date format." - }, - "timeFormat": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "HHMM", - "HHMMSS", - "HHMMSSdd", - "HHMMSSd" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The time format." - } - }, - "required": [ - "targetNamespace", - "protocolVersion", - "messageId", - "responsibleAgencyCode", - "headerVersion", - "senderApplicationId", - "receiverApplicationId", - "dateFormat", - "timeFormat" - ], - "description": "The X12 envelope override settings." - }, - "X12EnvelopeSettings": { - "type": "object", - "properties": { - "controlStandardsId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The controls standards id." - }, - "useControlStandardsIdAsRepetitionCharacter": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to use control standards id as repetition character." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "receiverApplicationId": { - "type": "string", - "description": "The receiver application id." - }, - "controlVersionNumber": { - "type": "string", - "description": "The control version number." - }, - "interchangeControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interchange control number lower bound." - }, - "interchangeControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The interchange control number upper bound." - }, - "rolloverInterchangeControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover interchange control number." - }, - "enableDefaultGroupHeaders": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to enable default group headers." - }, - "functionalGroupId": { - "type": "string", - "description": "The functional group id." - }, - "groupControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group control number lower bound." - }, - "groupControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group control number upper bound." - }, - "rolloverGroupControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover group control number." - }, - "groupHeaderAgencyCode": { - "type": "string", - "description": "The group header agency code." - }, - "groupHeaderVersion": { - "type": "string", - "description": "The group header version." - }, - "transactionSetControlNumberLowerBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transaction set control number lower bound." - }, - "transactionSetControlNumberUpperBound": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transaction set control number upper bound." - }, - "rolloverTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to rollover transaction set control number." - }, - "transactionSetControlNumberPrefix": { - "type": "string", - "description": "The transaction set control number prefix." - }, - "transactionSetControlNumberSuffix": { - "type": "string", - "description": "The transaction set control number suffix." - }, - "overwriteExistingTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to overwrite existing transaction set control number." - }, - "groupHeaderDateFormat": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "CCYYMMDD", - "YYMMDD" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group header date format." - }, - "groupHeaderTimeFormat": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "HHMM", - "HHMMSS", - "HHMMSSdd", - "HHMMSSd" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The group header time format." - }, - "usageIndicator": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Test", - "Information", - "Production" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The usage indicator." - } - }, - "required": [ - "controlStandardsId", - "useControlStandardsIdAsRepetitionCharacter", - "senderApplicationId", - "receiverApplicationId", - "controlVersionNumber", - "interchangeControlNumberLowerBound", - "interchangeControlNumberUpperBound", - "rolloverInterchangeControlNumber", - "enableDefaultGroupHeaders", - "groupControlNumberLowerBound", - "groupControlNumberUpperBound", - "rolloverGroupControlNumber", - "groupHeaderAgencyCode", - "groupHeaderVersion", - "transactionSetControlNumberLowerBound", - "transactionSetControlNumberUpperBound", - "rolloverTransactionSetControlNumber", - "overwriteExistingTransactionSetControlNumber", - "groupHeaderDateFormat", - "groupHeaderTimeFormat", - "usageIndicator" - ], - "description": "The X12 agreement envelope settings." - }, - "X12FramingSettings": { - "type": "object", - "properties": { - "dataElementSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The data element separator." - }, - "componentSeparator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The component separator." - }, - "replaceSeparatorsInPayload": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to replace separators in payload." - }, - "replaceCharacter": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The replacement character." - }, - "segmentTerminator": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator." - }, - "characterSet": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Basic", - "Extended", - "UTF8" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 character set." - }, - "segmentTerminatorSuffix": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "CR", - "LF", - "CRLF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The segment terminator suffix." - } - }, - "required": [ - "dataElementSeparator", - "componentSeparator", - "replaceSeparatorsInPayload", - "replaceCharacter", - "segmentTerminator", - "characterSet", - "segmentTerminatorSuffix" - ], - "description": "The X12 agreement framing settings." - }, - "X12MessageFilter": { - "type": "object", - "properties": { - "messageFilterType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "Include", - "Exclude" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The message filter type." - } - }, - "required": [ - "messageFilterType" - ], - "description": "The X12 message filter for odata query." - }, - "X12MessageIdentifier": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id." - } - }, - "required": [ - "messageId" - ], - "description": "The X12 message identifier." - }, - "X12OneWayAgreement": { - "type": "object", - "properties": { - "senderBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sender business identity" - }, - "receiverBusinessIdentity": { - "oneOf": [ - { - "$ref": "#/definitions/BusinessIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The receiver business identity" - }, - "protocolSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12ProtocolSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 protocol settings." - } - }, - "required": [ - "senderBusinessIdentity", - "receiverBusinessIdentity", - "protocolSettings" - ], - "description": "The X12 oneway agreement." - }, - "X12ProcessingSettings": { - "type": "object", - "properties": { - "maskSecurityInfo": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to mask security information." - }, - "convertImpliedDecimal": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to convert numerical type to implied decimal." - }, - "preserveInterchange": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to preserve interchange." - }, - "suspendInterchangeOnError": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to suspend interchange on error." - }, - "createEmptyXmlTagsForTrailingSeparators": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to create empty xml tags for trailing separators." - }, - "useDotAsDecimalSeparator": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to use dot as decimal separator." - } - }, - "required": [ - "maskSecurityInfo", - "convertImpliedDecimal", - "preserveInterchange", - "suspendInterchangeOnError", - "createEmptyXmlTagsForTrailingSeparators", - "useDotAsDecimalSeparator" - ], - "description": "The X12 processing settings." - }, - "X12ProtocolSettings": { - "type": "object", - "properties": { - "validationSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12ValidationSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 validation settings." - }, - "framingSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12FramingSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 framing settings." - }, - "envelopeSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12EnvelopeSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 envelope settings." - }, - "acknowledgementSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12AcknowledgementSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 acknowledgment settings." - }, - "messageFilter": { - "oneOf": [ - { - "$ref": "#/definitions/X12MessageFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 message filter." - }, - "securitySettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12SecuritySettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 security settings." - }, - "processingSettings": { - "oneOf": [ - { - "$ref": "#/definitions/X12ProcessingSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 processing settings." - }, - "envelopeOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12EnvelopeOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 envelope override settings." - }, - "validationOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12ValidationOverride" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 validation override settings." - }, - "messageFilterList": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12MessageIdentifier" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 message filter list." - }, - "schemaReferences": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12SchemaReference" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 schema references." - }, - "x12DelimiterOverrides": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/X12DelimiterOverrides" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The X12 delimiter override settings." - } - }, - "required": [ - "validationSettings", - "framingSettings", - "envelopeSettings", - "acknowledgementSettings", - "messageFilter", - "securitySettings", - "processingSettings", - "schemaReferences" - ], - "description": "The X12 agreement protocol settings." - }, - "X12SchemaReference": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "schemaVersion": { - "type": "string", - "description": "The schema version." - }, - "schemaName": { - "type": "string", - "description": "The schema name." - } - }, - "required": [ - "messageId", - "schemaVersion", - "schemaName" - ], - "description": "The X12 schema reference." - }, - "X12SecuritySettings": { - "type": "object", - "properties": { - "authorizationQualifier": { - "type": "string", - "description": "The authorization qualifier." - }, - "authorizationValue": { - "type": "string", - "description": "The authorization value." - }, - "securityQualifier": { - "type": "string", - "description": "The security qualifier." - }, - "passwordValue": { - "type": "string", - "description": "The password value." - } - }, - "required": [ - "authorizationQualifier", - "securityQualifier" - ], - "description": "The X12 agreement security settings." - }, - "X12ValidationOverride": { - "type": "object", - "properties": { - "messageId": { - "type": "string", - "description": "The message id on which the validation settings has to be applied." - }, - "validateEdiTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate EDI types." - }, - "validateXsdTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate XSD types." - }, - "allowLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." - }, - "validateCharacterSet": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate character Set." - }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." - }, - "trailingSeparatorPolicy": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "NotAllowed", - "Optional", - "Mandatory" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The trailing separator policy." - } - }, - "required": [ - "messageId", - "validateEdiTypes", - "validateXsdTypes", - "allowLeadingAndTrailingSpacesAndZeroes", - "validateCharacterSet", - "trimLeadingAndTrailingSpacesAndZeroes", - "trailingSeparatorPolicy" - ], - "description": "The X12 validation override settings." - }, - "X12ValidationSettings": { - "type": "object", - "properties": { - "validateCharacterSet": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to validate character set in the message." - }, - "checkDuplicateInterchangeControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate interchange control number." - }, - "interchangeControlNumberValidityDays": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The validity period of interchange control number." - }, - "checkDuplicateGroupControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate group control number." - }, - "checkDuplicateTransactionSetControlNumber": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to check for duplicate transaction set control number." - }, - "validateEdiTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to Whether to validate EDI types." - }, - "validateXsdTypes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to Whether to validate XSD types." - }, - "allowLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." - }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." - }, - "trailingSeparatorPolicy": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotSpecified", - "NotAllowed", - "Optional", - "Mandatory" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The trailing separator policy." - } - }, - "required": [ - "validateCharacterSet", - "checkDuplicateInterchangeControlNumber", - "interchangeControlNumberValidityDays", - "checkDuplicateGroupControlNumber", - "checkDuplicateTransactionSetControlNumber", - "validateEdiTypes", - "validateXsdTypes", - "allowLeadingAndTrailingSpacesAndZeroes", - "trimLeadingAndTrailingSpacesAndZeroes", - "trailingSeparatorPolicy" - ], - "description": "The X12 agreement validation settings." - } - } -} diff --git a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts.md b/test/Resource/Expected/Logic/2016-06-01/integrationAccounts.md deleted file mode 100644 index 5e8e975..0000000 --- a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.Logic/integrationAccounts template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Logic/integrationAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts", - "apiVersion": "2016-06-01", - "location": "string", - "tags": {}, - "properties": {}, - "sku": { - "name": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts | -| apiVersion | enum | Yes | 2016-06-01 | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account properties. | -| sku | object | No | The sku. - [IntegrationAccountSku object](#IntegrationAccountSku) | -| resources | array | No | [sessions](./integrationAccounts/sessions.md) [certificates](./integrationAccounts/certificates.md) [agreements](./integrationAccounts/agreements.md) [partners](./integrationAccounts/partners.md) [maps](./integrationAccounts/maps.md) [schemas](./integrationAccounts/schemas.md) | - - - -### IntegrationAccountSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The sku name. - NotSpecified, Free, Standard | - diff --git a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/agreements.md b/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/agreements.md deleted file mode 100644 index 472136b..0000000 --- a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/agreements.md +++ /dev/null @@ -1,1382 +0,0 @@ -# Microsoft.Logic/integrationAccounts/agreements template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Logic/integrationAccounts/agreements resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/agreements", - "apiVersion": "2016-06-01", - "location": "string", - "tags": {}, - "properties": { - "metadata": {}, - "agreementType": "string", - "hostPartner": "string", - "guestPartner": "string", - "hostIdentity": { - "qualifier": "string", - "value": "string" - }, - "guestIdentity": { - "qualifier": "string", - "value": "string" - }, - "content": { - "aS2": { - "receiveAgreement": { - "senderBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "receiverBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "protocolSettings": { - "messageConnectionSettings": { - "ignoreCertificateNameMismatch": "boolean", - "supportHttpStatusCodeContinue": "boolean", - "keepHttpConnectionAlive": "boolean", - "unfoldHttpHeaders": "boolean" - }, - "acknowledgementConnectionSettings": { - "ignoreCertificateNameMismatch": "boolean", - "supportHttpStatusCodeContinue": "boolean", - "keepHttpConnectionAlive": "boolean", - "unfoldHttpHeaders": "boolean" - }, - "mdnSettings": { - "needMdn": "boolean", - "signMdn": "boolean", - "sendMdnAsynchronously": "boolean", - "receiptDeliveryUrl": "string", - "dispositionNotificationTo": "string", - "signOutboundMdnIfOptional": "boolean", - "mdnText": "string", - "sendInboundMdnToMessageBox": "boolean", - "micHashingAlgorithm": "string" - }, - "securitySettings": { - "overrideGroupSigningCertificate": "boolean", - "signingCertificateName": "string", - "encryptionCertificateName": "string", - "enableNrrForInboundEncodedMessages": "boolean", - "enableNrrForInboundDecodedMessages": "boolean", - "enableNrrForOutboundMdn": "boolean", - "enableNrrForOutboundEncodedMessages": "boolean", - "enableNrrForOutboundDecodedMessages": "boolean", - "enableNrrForInboundMdn": "boolean", - "sha2AlgorithmFormat": "string" - }, - "validationSettings": { - "overrideMessageProperties": "boolean", - "encryptMessage": "boolean", - "signMessage": "boolean", - "compressMessage": "boolean", - "checkDuplicateMessage": "boolean", - "interchangeDuplicatesValidityDays": "integer", - "checkCertificateRevocationListOnSend": "boolean", - "checkCertificateRevocationListOnReceive": "boolean", - "encryptionAlgorithm": "string", - "signingAlgorithm": "string" - }, - "envelopeSettings": { - "messageContentType": "string", - "transmitFileNameInMimeHeader": "boolean", - "fileNameTemplate": "string", - "suspendMessageOnFileNameGenerationError": "boolean", - "autogenerateFileName": "boolean" - }, - "errorSettings": { - "suspendDuplicateMessage": "boolean", - "resendIfMdnNotReceived": "boolean" - } - } - }, - "sendAgreement": { - "senderBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "receiverBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "protocolSettings": { - "messageConnectionSettings": { - "ignoreCertificateNameMismatch": "boolean", - "supportHttpStatusCodeContinue": "boolean", - "keepHttpConnectionAlive": "boolean", - "unfoldHttpHeaders": "boolean" - }, - "acknowledgementConnectionSettings": { - "ignoreCertificateNameMismatch": "boolean", - "supportHttpStatusCodeContinue": "boolean", - "keepHttpConnectionAlive": "boolean", - "unfoldHttpHeaders": "boolean" - }, - "mdnSettings": { - "needMdn": "boolean", - "signMdn": "boolean", - "sendMdnAsynchronously": "boolean", - "receiptDeliveryUrl": "string", - "dispositionNotificationTo": "string", - "signOutboundMdnIfOptional": "boolean", - "mdnText": "string", - "sendInboundMdnToMessageBox": "boolean", - "micHashingAlgorithm": "string" - }, - "securitySettings": { - "overrideGroupSigningCertificate": "boolean", - "signingCertificateName": "string", - "encryptionCertificateName": "string", - "enableNrrForInboundEncodedMessages": "boolean", - "enableNrrForInboundDecodedMessages": "boolean", - "enableNrrForOutboundMdn": "boolean", - "enableNrrForOutboundEncodedMessages": "boolean", - "enableNrrForOutboundDecodedMessages": "boolean", - "enableNrrForInboundMdn": "boolean", - "sha2AlgorithmFormat": "string" - }, - "validationSettings": { - "overrideMessageProperties": "boolean", - "encryptMessage": "boolean", - "signMessage": "boolean", - "compressMessage": "boolean", - "checkDuplicateMessage": "boolean", - "interchangeDuplicatesValidityDays": "integer", - "checkCertificateRevocationListOnSend": "boolean", - "checkCertificateRevocationListOnReceive": "boolean", - "encryptionAlgorithm": "string", - "signingAlgorithm": "string" - }, - "envelopeSettings": { - "messageContentType": "string", - "transmitFileNameInMimeHeader": "boolean", - "fileNameTemplate": "string", - "suspendMessageOnFileNameGenerationError": "boolean", - "autogenerateFileName": "boolean" - }, - "errorSettings": { - "suspendDuplicateMessage": "boolean", - "resendIfMdnNotReceived": "boolean" - } - } - } - }, - "x12": { - "receiveAgreement": { - "senderBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "receiverBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "protocolSettings": { - "validationSettings": { - "validateCharacterSet": "boolean", - "checkDuplicateInterchangeControlNumber": "boolean", - "interchangeControlNumberValidityDays": "integer", - "checkDuplicateGroupControlNumber": "boolean", - "checkDuplicateTransactionSetControlNumber": "boolean", - "validateEdiTypes": "boolean", - "validateXsdTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - }, - "framingSettings": { - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "replaceSeparatorsInPayload": "boolean", - "replaceCharacter": "integer", - "segmentTerminator": "integer", - "characterSet": "string", - "segmentTerminatorSuffix": "string" - }, - "envelopeSettings": { - "controlStandardsId": "integer", - "useControlStandardsIdAsRepetitionCharacter": "boolean", - "senderApplicationId": "string", - "receiverApplicationId": "string", - "controlVersionNumber": "string", - "interchangeControlNumberLowerBound": "integer", - "interchangeControlNumberUpperBound": "integer", - "rolloverInterchangeControlNumber": "boolean", - "enableDefaultGroupHeaders": "boolean", - "functionalGroupId": "string", - "groupControlNumberLowerBound": "integer", - "groupControlNumberUpperBound": "integer", - "rolloverGroupControlNumber": "boolean", - "groupHeaderAgencyCode": "string", - "groupHeaderVersion": "string", - "transactionSetControlNumberLowerBound": "integer", - "transactionSetControlNumberUpperBound": "integer", - "rolloverTransactionSetControlNumber": "boolean", - "transactionSetControlNumberPrefix": "string", - "transactionSetControlNumberSuffix": "string", - "overwriteExistingTransactionSetControlNumber": "boolean", - "groupHeaderDateFormat": "string", - "groupHeaderTimeFormat": "string", - "usageIndicator": "string" - }, - "acknowledgementSettings": { - "needTechnicalAcknowledgement": "boolean", - "batchTechnicalAcknowledgements": "boolean", - "needFunctionalAcknowledgement": "boolean", - "functionalAcknowledgementVersion": "string", - "batchFunctionalAcknowledgements": "boolean", - "needImplementationAcknowledgement": "boolean", - "implementationAcknowledgementVersion": "string", - "batchImplementationAcknowledgements": "boolean", - "needLoopForValidMessages": "boolean", - "sendSynchronousAcknowledgement": "boolean", - "acknowledgementControlNumberPrefix": "string", - "acknowledgementControlNumberSuffix": "string", - "acknowledgementControlNumberLowerBound": "integer", - "acknowledgementControlNumberUpperBound": "integer", - "rolloverAcknowledgementControlNumber": "boolean" - }, - "messageFilter": { - "messageFilterType": "string" - }, - "securitySettings": { - "authorizationQualifier": "string", - "authorizationValue": "string", - "securityQualifier": "string", - "passwordValue": "string" - }, - "processingSettings": { - "maskSecurityInfo": "boolean", - "convertImpliedDecimal": "boolean", - "preserveInterchange": "boolean", - "suspendInterchangeOnError": "boolean", - "createEmptyXmlTagsForTrailingSeparators": "boolean", - "useDotAsDecimalSeparator": "boolean" - }, - "envelopeOverrides": [ - { - "targetNamespace": "string", - "protocolVersion": "string", - "messageId": "string", - "responsibleAgencyCode": "string", - "headerVersion": "string", - "senderApplicationId": "string", - "receiverApplicationId": "string", - "functionalIdentifierCode": "string", - "dateFormat": "string", - "timeFormat": "string" - } - ], - "validationOverrides": [ - { - "messageId": "string", - "validateEdiTypes": "boolean", - "validateXsdTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "validateCharacterSet": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - } - ], - "messageFilterList": [ - { - "messageId": "string" - } - ], - "schemaReferences": [ - { - "messageId": "string", - "senderApplicationId": "string", - "schemaVersion": "string", - "schemaName": "string" - } - ], - "x12DelimiterOverrides": [ - { - "protocolVersion": "string", - "messageId": "string", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "segmentTerminatorSuffix": "string", - "replaceCharacter": "integer", - "replaceSeparatorsInPayload": "boolean", - "targetNamespace": "string" - } - ] - } - }, - "sendAgreement": { - "senderBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "receiverBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "protocolSettings": { - "validationSettings": { - "validateCharacterSet": "boolean", - "checkDuplicateInterchangeControlNumber": "boolean", - "interchangeControlNumberValidityDays": "integer", - "checkDuplicateGroupControlNumber": "boolean", - "checkDuplicateTransactionSetControlNumber": "boolean", - "validateEdiTypes": "boolean", - "validateXsdTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - }, - "framingSettings": { - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "replaceSeparatorsInPayload": "boolean", - "replaceCharacter": "integer", - "segmentTerminator": "integer", - "characterSet": "string", - "segmentTerminatorSuffix": "string" - }, - "envelopeSettings": { - "controlStandardsId": "integer", - "useControlStandardsIdAsRepetitionCharacter": "boolean", - "senderApplicationId": "string", - "receiverApplicationId": "string", - "controlVersionNumber": "string", - "interchangeControlNumberLowerBound": "integer", - "interchangeControlNumberUpperBound": "integer", - "rolloverInterchangeControlNumber": "boolean", - "enableDefaultGroupHeaders": "boolean", - "functionalGroupId": "string", - "groupControlNumberLowerBound": "integer", - "groupControlNumberUpperBound": "integer", - "rolloverGroupControlNumber": "boolean", - "groupHeaderAgencyCode": "string", - "groupHeaderVersion": "string", - "transactionSetControlNumberLowerBound": "integer", - "transactionSetControlNumberUpperBound": "integer", - "rolloverTransactionSetControlNumber": "boolean", - "transactionSetControlNumberPrefix": "string", - "transactionSetControlNumberSuffix": "string", - "overwriteExistingTransactionSetControlNumber": "boolean", - "groupHeaderDateFormat": "string", - "groupHeaderTimeFormat": "string", - "usageIndicator": "string" - }, - "acknowledgementSettings": { - "needTechnicalAcknowledgement": "boolean", - "batchTechnicalAcknowledgements": "boolean", - "needFunctionalAcknowledgement": "boolean", - "functionalAcknowledgementVersion": "string", - "batchFunctionalAcknowledgements": "boolean", - "needImplementationAcknowledgement": "boolean", - "implementationAcknowledgementVersion": "string", - "batchImplementationAcknowledgements": "boolean", - "needLoopForValidMessages": "boolean", - "sendSynchronousAcknowledgement": "boolean", - "acknowledgementControlNumberPrefix": "string", - "acknowledgementControlNumberSuffix": "string", - "acknowledgementControlNumberLowerBound": "integer", - "acknowledgementControlNumberUpperBound": "integer", - "rolloverAcknowledgementControlNumber": "boolean" - }, - "messageFilter": { - "messageFilterType": "string" - }, - "securitySettings": { - "authorizationQualifier": "string", - "authorizationValue": "string", - "securityQualifier": "string", - "passwordValue": "string" - }, - "processingSettings": { - "maskSecurityInfo": "boolean", - "convertImpliedDecimal": "boolean", - "preserveInterchange": "boolean", - "suspendInterchangeOnError": "boolean", - "createEmptyXmlTagsForTrailingSeparators": "boolean", - "useDotAsDecimalSeparator": "boolean" - }, - "envelopeOverrides": [ - { - "targetNamespace": "string", - "protocolVersion": "string", - "messageId": "string", - "responsibleAgencyCode": "string", - "headerVersion": "string", - "senderApplicationId": "string", - "receiverApplicationId": "string", - "functionalIdentifierCode": "string", - "dateFormat": "string", - "timeFormat": "string" - } - ], - "validationOverrides": [ - { - "messageId": "string", - "validateEdiTypes": "boolean", - "validateXsdTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "validateCharacterSet": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - } - ], - "messageFilterList": [ - { - "messageId": "string" - } - ], - "schemaReferences": [ - { - "messageId": "string", - "senderApplicationId": "string", - "schemaVersion": "string", - "schemaName": "string" - } - ], - "x12DelimiterOverrides": [ - { - "protocolVersion": "string", - "messageId": "string", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "segmentTerminatorSuffix": "string", - "replaceCharacter": "integer", - "replaceSeparatorsInPayload": "boolean", - "targetNamespace": "string" - } - ] - } - } - }, - "edifact": { - "receiveAgreement": { - "senderBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "receiverBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "protocolSettings": { - "validationSettings": { - "validateCharacterSet": "boolean", - "checkDuplicateInterchangeControlNumber": "boolean", - "interchangeControlNumberValidityDays": "integer", - "checkDuplicateGroupControlNumber": "boolean", - "checkDuplicateTransactionSetControlNumber": "boolean", - "validateEdiTypes": "boolean", - "validateXsdTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - }, - "framingSettings": { - "serviceCodeListDirectoryVersion": "string", - "characterEncoding": "string", - "protocolVersion": "integer", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "releaseIndicator": "integer", - "repetitionSeparator": "integer", - "characterSet": "string", - "decimalPointIndicator": "string", - "segmentTerminatorSuffix": "string" - }, - "envelopeSettings": { - "groupAssociationAssignedCode": "string", - "communicationAgreementId": "string", - "applyDelimiterStringAdvice": "boolean", - "createGroupingSegments": "boolean", - "enableDefaultGroupHeaders": "boolean", - "recipientReferencePasswordValue": "string", - "recipientReferencePasswordQualifier": "string", - "applicationReferenceId": "string", - "processingPriorityCode": "string", - "interchangeControlNumberLowerBound": "integer", - "interchangeControlNumberUpperBound": "integer", - "rolloverInterchangeControlNumber": "boolean", - "interchangeControlNumberPrefix": "string", - "interchangeControlNumberSuffix": "string", - "senderReverseRoutingAddress": "string", - "receiverReverseRoutingAddress": "string", - "functionalGroupId": "string", - "groupControllingAgencyCode": "string", - "groupMessageVersion": "string", - "groupMessageRelease": "string", - "groupControlNumberLowerBound": "integer", - "groupControlNumberUpperBound": "integer", - "rolloverGroupControlNumber": "boolean", - "groupControlNumberPrefix": "string", - "groupControlNumberSuffix": "string", - "groupApplicationReceiverQualifier": "string", - "groupApplicationReceiverId": "string", - "groupApplicationSenderQualifier": "string", - "groupApplicationSenderId": "string", - "groupApplicationPassword": "string", - "overwriteExistingTransactionSetControlNumber": "boolean", - "transactionSetControlNumberPrefix": "string", - "transactionSetControlNumberSuffix": "string", - "transactionSetControlNumberLowerBound": "integer", - "transactionSetControlNumberUpperBound": "integer", - "rolloverTransactionSetControlNumber": "boolean", - "isTestInterchange": "boolean", - "senderInternalIdentification": "string", - "senderInternalSubIdentification": "string", - "receiverInternalIdentification": "string", - "receiverInternalSubIdentification": "string" - }, - "acknowledgementSettings": { - "needTechnicalAcknowledgement": "boolean", - "batchTechnicalAcknowledgements": "boolean", - "needFunctionalAcknowledgement": "boolean", - "batchFunctionalAcknowledgements": "boolean", - "needLoopForValidMessages": "boolean", - "sendSynchronousAcknowledgement": "boolean", - "acknowledgementControlNumberPrefix": "string", - "acknowledgementControlNumberSuffix": "string", - "acknowledgementControlNumberLowerBound": "integer", - "acknowledgementControlNumberUpperBound": "integer", - "rolloverAcknowledgementControlNumber": "boolean" - }, - "messageFilter": { - "messageFilterType": "string" - }, - "processingSettings": { - "maskSecurityInfo": "boolean", - "preserveInterchange": "boolean", - "suspendInterchangeOnError": "boolean", - "createEmptyXmlTagsForTrailingSeparators": "boolean", - "useDotAsDecimalSeparator": "boolean" - }, - "envelopeOverrides": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "messageAssociationAssignedCode": "string", - "targetNamespace": "string", - "functionalGroupId": "string", - "senderApplicationQualifier": "string", - "senderApplicationId": "string", - "receiverApplicationQualifier": "string", - "receiverApplicationId": "string", - "controllingAgencyCode": "string", - "groupHeaderMessageVersion": "string", - "groupHeaderMessageRelease": "string", - "associationAssignedCode": "string", - "applicationPassword": "string" - } - ], - "messageFilterList": [ - { - "messageId": "string" - } - ], - "schemaReferences": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "senderApplicationId": "string", - "senderApplicationQualifier": "string", - "associationAssignedCode": "string", - "schemaName": "string" - } - ], - "validationOverrides": [ - { - "messageId": "string", - "enforceCharacterSet": "boolean", - "validateEdiTypes": "boolean", - "validateXsdTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean" - } - ], - "edifactDelimiterOverrides": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "repetitionSeparator": "integer", - "segmentTerminatorSuffix": "string", - "decimalPointIndicator": "string", - "releaseIndicator": "integer", - "messageAssociationAssignedCode": "string", - "targetNamespace": "string" - } - ] - } - }, - "sendAgreement": { - "senderBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "receiverBusinessIdentity": { - "qualifier": "string", - "value": "string" - }, - "protocolSettings": { - "validationSettings": { - "validateCharacterSet": "boolean", - "checkDuplicateInterchangeControlNumber": "boolean", - "interchangeControlNumberValidityDays": "integer", - "checkDuplicateGroupControlNumber": "boolean", - "checkDuplicateTransactionSetControlNumber": "boolean", - "validateEdiTypes": "boolean", - "validateXsdTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string" - }, - "framingSettings": { - "serviceCodeListDirectoryVersion": "string", - "characterEncoding": "string", - "protocolVersion": "integer", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "releaseIndicator": "integer", - "repetitionSeparator": "integer", - "characterSet": "string", - "decimalPointIndicator": "string", - "segmentTerminatorSuffix": "string" - }, - "envelopeSettings": { - "groupAssociationAssignedCode": "string", - "communicationAgreementId": "string", - "applyDelimiterStringAdvice": "boolean", - "createGroupingSegments": "boolean", - "enableDefaultGroupHeaders": "boolean", - "recipientReferencePasswordValue": "string", - "recipientReferencePasswordQualifier": "string", - "applicationReferenceId": "string", - "processingPriorityCode": "string", - "interchangeControlNumberLowerBound": "integer", - "interchangeControlNumberUpperBound": "integer", - "rolloverInterchangeControlNumber": "boolean", - "interchangeControlNumberPrefix": "string", - "interchangeControlNumberSuffix": "string", - "senderReverseRoutingAddress": "string", - "receiverReverseRoutingAddress": "string", - "functionalGroupId": "string", - "groupControllingAgencyCode": "string", - "groupMessageVersion": "string", - "groupMessageRelease": "string", - "groupControlNumberLowerBound": "integer", - "groupControlNumberUpperBound": "integer", - "rolloverGroupControlNumber": "boolean", - "groupControlNumberPrefix": "string", - "groupControlNumberSuffix": "string", - "groupApplicationReceiverQualifier": "string", - "groupApplicationReceiverId": "string", - "groupApplicationSenderQualifier": "string", - "groupApplicationSenderId": "string", - "groupApplicationPassword": "string", - "overwriteExistingTransactionSetControlNumber": "boolean", - "transactionSetControlNumberPrefix": "string", - "transactionSetControlNumberSuffix": "string", - "transactionSetControlNumberLowerBound": "integer", - "transactionSetControlNumberUpperBound": "integer", - "rolloverTransactionSetControlNumber": "boolean", - "isTestInterchange": "boolean", - "senderInternalIdentification": "string", - "senderInternalSubIdentification": "string", - "receiverInternalIdentification": "string", - "receiverInternalSubIdentification": "string" - }, - "acknowledgementSettings": { - "needTechnicalAcknowledgement": "boolean", - "batchTechnicalAcknowledgements": "boolean", - "needFunctionalAcknowledgement": "boolean", - "batchFunctionalAcknowledgements": "boolean", - "needLoopForValidMessages": "boolean", - "sendSynchronousAcknowledgement": "boolean", - "acknowledgementControlNumberPrefix": "string", - "acknowledgementControlNumberSuffix": "string", - "acknowledgementControlNumberLowerBound": "integer", - "acknowledgementControlNumberUpperBound": "integer", - "rolloverAcknowledgementControlNumber": "boolean" - }, - "messageFilter": { - "messageFilterType": "string" - }, - "processingSettings": { - "maskSecurityInfo": "boolean", - "preserveInterchange": "boolean", - "suspendInterchangeOnError": "boolean", - "createEmptyXmlTagsForTrailingSeparators": "boolean", - "useDotAsDecimalSeparator": "boolean" - }, - "envelopeOverrides": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "messageAssociationAssignedCode": "string", - "targetNamespace": "string", - "functionalGroupId": "string", - "senderApplicationQualifier": "string", - "senderApplicationId": "string", - "receiverApplicationQualifier": "string", - "receiverApplicationId": "string", - "controllingAgencyCode": "string", - "groupHeaderMessageVersion": "string", - "groupHeaderMessageRelease": "string", - "associationAssignedCode": "string", - "applicationPassword": "string" - } - ], - "messageFilterList": [ - { - "messageId": "string" - } - ], - "schemaReferences": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "senderApplicationId": "string", - "senderApplicationQualifier": "string", - "associationAssignedCode": "string", - "schemaName": "string" - } - ], - "validationOverrides": [ - { - "messageId": "string", - "enforceCharacterSet": "boolean", - "validateEdiTypes": "boolean", - "validateXsdTypes": "boolean", - "allowLeadingAndTrailingSpacesAndZeroes": "boolean", - "trailingSeparatorPolicy": "string", - "trimLeadingAndTrailingSpacesAndZeroes": "boolean" - } - ], - "edifactDelimiterOverrides": [ - { - "messageId": "string", - "messageVersion": "string", - "messageRelease": "string", - "dataElementSeparator": "integer", - "componentSeparator": "integer", - "segmentTerminator": "integer", - "repetitionSeparator": "integer", - "segmentTerminatorSuffix": "string", - "decimalPointIndicator": "string", - "releaseIndicator": "integer", - "messageAssociationAssignedCode": "string", - "targetNamespace": "string" - } - ] - } - } - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/agreements object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/agreements | -| apiVersion | enum | Yes | 2016-06-01 | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account agreement properties. - [IntegrationAccountAgreementProperties object](#IntegrationAccountAgreementProperties) | - - - -### IntegrationAccountAgreementProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| metadata | object | No | The metadata. | -| agreementType | enum | Yes | The agreement type. - NotSpecified, AS2, X12, Edifact | -| hostPartner | string | Yes | The integration account partner that is set as host partner for this agreement. | -| guestPartner | string | Yes | The integration account partner that is set as guest partner for this agreement. | -| hostIdentity | object | Yes | The business identity of the host partner. - [BusinessIdentity object](#BusinessIdentity) | -| guestIdentity | object | Yes | The business identity of the guest partner. - [BusinessIdentity object](#BusinessIdentity) | -| content | object | Yes | The agreement content. - [AgreementContent object](#AgreementContent) | - - - -### BusinessIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| qualifier | string | Yes | The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 | -| value | string | Yes | The user defined business identity value. | - - - -### AgreementContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| aS2 | object | No | The AS2 agreement content. - [AS2AgreementContent object](#AS2AgreementContent) | -| x12 | object | No | The X12 agreement content. - [X12AgreementContent object](#X12AgreementContent) | -| edifact | object | No | The EDIFACT agreement content. - [EdifactAgreementContent object](#EdifactAgreementContent) | - - - -### AS2AgreementContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| receiveAgreement | object | Yes | The AS2 one-way receive agreement. - [AS2OneWayAgreement object](#AS2OneWayAgreement) | -| sendAgreement | object | Yes | The AS2 one-way send agreement. - [AS2OneWayAgreement object](#AS2OneWayAgreement) | - - - -### X12AgreementContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| receiveAgreement | object | Yes | The X12 one-way receive agreement. - [X12OneWayAgreement object](#X12OneWayAgreement) | -| sendAgreement | object | Yes | The X12 one-way send agreement. - [X12OneWayAgreement object](#X12OneWayAgreement) | - - - -### EdifactAgreementContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| receiveAgreement | object | Yes | The EDIFACT one-way receive agreement. - [EdifactOneWayAgreement object](#EdifactOneWayAgreement) | -| sendAgreement | object | Yes | The EDIFACT one-way send agreement. - [EdifactOneWayAgreement object](#EdifactOneWayAgreement) | - - - -### AS2OneWayAgreement object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| senderBusinessIdentity | object | Yes | The sender business identity - [BusinessIdentity object](#BusinessIdentity) | -| receiverBusinessIdentity | object | Yes | The receiver business identity - [BusinessIdentity object](#BusinessIdentity) | -| protocolSettings | object | Yes | The AS2 protocol settings. - [AS2ProtocolSettings object](#AS2ProtocolSettings) | - - - -### X12OneWayAgreement object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| senderBusinessIdentity | object | Yes | The sender business identity - [BusinessIdentity object](#BusinessIdentity) | -| receiverBusinessIdentity | object | Yes | The receiver business identity - [BusinessIdentity object](#BusinessIdentity) | -| protocolSettings | object | Yes | The X12 protocol settings. - [X12ProtocolSettings object](#X12ProtocolSettings) | - - - -### EdifactOneWayAgreement object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| senderBusinessIdentity | object | Yes | The sender business identity - [BusinessIdentity object](#BusinessIdentity) | -| receiverBusinessIdentity | object | Yes | The receiver business identity - [BusinessIdentity object](#BusinessIdentity) | -| protocolSettings | object | Yes | The EDIFACT protocol settings. - [EdifactProtocolSettings object](#EdifactProtocolSettings) | - - - -### AS2ProtocolSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageConnectionSettings | object | Yes | The message connection settings. - [AS2MessageConnectionSettings object](#AS2MessageConnectionSettings) | -| acknowledgementConnectionSettings | object | Yes | The acknowledgement connection settings. - [AS2AcknowledgementConnectionSettings object](#AS2AcknowledgementConnectionSettings) | -| mdnSettings | object | Yes | The MDN settings. - [AS2MdnSettings object](#AS2MdnSettings) | -| securitySettings | object | Yes | The security settings. - [AS2SecuritySettings object](#AS2SecuritySettings) | -| validationSettings | object | Yes | The validation settings. - [AS2ValidationSettings object](#AS2ValidationSettings) | -| envelopeSettings | object | Yes | The envelope settings. - [AS2EnvelopeSettings object](#AS2EnvelopeSettings) | -| errorSettings | object | Yes | The error settings. - [AS2ErrorSettings object](#AS2ErrorSettings) | - - - -### X12ProtocolSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| validationSettings | object | Yes | The X12 validation settings. - [X12ValidationSettings object](#X12ValidationSettings) | -| framingSettings | object | Yes | The X12 framing settings. - [X12FramingSettings object](#X12FramingSettings) | -| envelopeSettings | object | Yes | The X12 envelope settings. - [X12EnvelopeSettings object](#X12EnvelopeSettings) | -| acknowledgementSettings | object | Yes | The X12 acknowledgment settings. - [X12AcknowledgementSettings object](#X12AcknowledgementSettings) | -| messageFilter | object | Yes | The X12 message filter. - [X12MessageFilter object](#X12MessageFilter) | -| securitySettings | object | Yes | The X12 security settings. - [X12SecuritySettings object](#X12SecuritySettings) | -| processingSettings | object | Yes | The X12 processing settings. - [X12ProcessingSettings object](#X12ProcessingSettings) | -| envelopeOverrides | array | No | The X12 envelope override settings. - [X12EnvelopeOverride object](#X12EnvelopeOverride) | -| validationOverrides | array | No | The X12 validation override settings. - [X12ValidationOverride object](#X12ValidationOverride) | -| messageFilterList | array | No | The X12 message filter list. - [X12MessageIdentifier object](#X12MessageIdentifier) | -| schemaReferences | array | Yes | The X12 schema references. - [X12SchemaReference object](#X12SchemaReference) | -| x12DelimiterOverrides | array | No | The X12 delimiter override settings. - [X12DelimiterOverrides object](#X12DelimiterOverrides) | - - - -### EdifactProtocolSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| validationSettings | object | Yes | The EDIFACT validation settings. - [EdifactValidationSettings object](#EdifactValidationSettings) | -| framingSettings | object | Yes | The EDIFACT framing settings. - [EdifactFramingSettings object](#EdifactFramingSettings) | -| envelopeSettings | object | Yes | The EDIFACT envelope settings. - [EdifactEnvelopeSettings object](#EdifactEnvelopeSettings) | -| acknowledgementSettings | object | Yes | The EDIFACT acknowledgement settings. - [EdifactAcknowledgementSettings object](#EdifactAcknowledgementSettings) | -| messageFilter | object | Yes | The EDIFACT message filter. - [EdifactMessageFilter object](#EdifactMessageFilter) | -| processingSettings | object | Yes | The EDIFACT processing Settings. - [EdifactProcessingSettings object](#EdifactProcessingSettings) | -| envelopeOverrides | array | No | The EDIFACT envelope override settings. - [EdifactEnvelopeOverride object](#EdifactEnvelopeOverride) | -| messageFilterList | array | No | The EDIFACT message filter list. - [EdifactMessageIdentifier object](#EdifactMessageIdentifier) | -| schemaReferences | array | Yes | The EDIFACT schema references. - [EdifactSchemaReference object](#EdifactSchemaReference) | -| validationOverrides | array | No | The EDIFACT validation override settings. - [EdifactValidationOverride object](#EdifactValidationOverride) | -| edifactDelimiterOverrides | array | No | The EDIFACT delimiter override settings. - [EdifactDelimiterOverride object](#EdifactDelimiterOverride) | - - - -### AS2MessageConnectionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ignoreCertificateNameMismatch | boolean | Yes | The value indicating whether to ignore mismatch in certificate name. | -| supportHttpStatusCodeContinue | boolean | Yes | The value indicating whether to support HTTP status code 'CONTINUE'. | -| keepHttpConnectionAlive | boolean | Yes | The value indicating whether to keep the connection alive. | -| unfoldHttpHeaders | boolean | Yes | The value indicating whether to unfold the HTTP headers. | - - - -### AS2AcknowledgementConnectionSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ignoreCertificateNameMismatch | boolean | Yes | The value indicating whether to ignore mismatch in certificate name. | -| supportHttpStatusCodeContinue | boolean | Yes | The value indicating whether to support HTTP status code 'CONTINUE'. | -| keepHttpConnectionAlive | boolean | Yes | The value indicating whether to keep the connection alive. | -| unfoldHttpHeaders | boolean | Yes | The value indicating whether to unfold the HTTP headers. | - - - -### AS2MdnSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| needMdn | boolean | Yes | The value indicating whether to send or request a MDN. | -| signMdn | boolean | Yes | The value indicating whether the MDN needs to be signed or not. | -| sendMdnAsynchronously | boolean | Yes | The value indicating whether to send the asynchronous MDN. | -| receiptDeliveryUrl | string | No | The receipt delivery URL. | -| dispositionNotificationTo | string | No | The disposition notification to header value. | -| signOutboundMdnIfOptional | boolean | Yes | The value indicating whether to sign the outbound MDN if optional. | -| mdnText | string | No | The MDN text. | -| sendInboundMdnToMessageBox | boolean | Yes | The value indicating whether to send inbound MDN to message box. | -| micHashingAlgorithm | enum | Yes | The signing or hashing algorithm. - NotSpecified, None, MD5, SHA1, SHA2256, SHA2384, SHA2512 | - - - -### AS2SecuritySettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| overrideGroupSigningCertificate | boolean | Yes | The value indicating whether to send or request a MDN. | -| signingCertificateName | string | No | The name of the signing certificate. | -| encryptionCertificateName | string | No | The name of the encryption certificate. | -| enableNrrForInboundEncodedMessages | boolean | Yes | The value indicating whether to enable NRR for inbound encoded messages. | -| enableNrrForInboundDecodedMessages | boolean | Yes | The value indicating whether to enable NRR for inbound decoded messages. | -| enableNrrForOutboundMdn | boolean | Yes | The value indicating whether to enable NRR for outbound MDN. | -| enableNrrForOutboundEncodedMessages | boolean | Yes | The value indicating whether to enable NRR for outbound encoded messages. | -| enableNrrForOutboundDecodedMessages | boolean | Yes | The value indicating whether to enable NRR for outbound decoded messages. | -| enableNrrForInboundMdn | boolean | Yes | The value indicating whether to enable NRR for inbound MDN. | -| sha2AlgorithmFormat | string | No | The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. | - - - -### AS2ValidationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| overrideMessageProperties | boolean | Yes | The value indicating whether to override incoming message properties with those in agreement. | -| encryptMessage | boolean | Yes | The value indicating whether the message has to be encrypted. | -| signMessage | boolean | Yes | The value indicating whether the message has to be signed. | -| compressMessage | boolean | Yes | The value indicating whether the message has to be compressed. | -| checkDuplicateMessage | boolean | Yes | The value indicating whether to check for duplicate message. | -| interchangeDuplicatesValidityDays | integer | Yes | The number of days to look back for duplicate interchange. | -| checkCertificateRevocationListOnSend | boolean | Yes | The value indicating whether to check for certificate revocation list on send. | -| checkCertificateRevocationListOnReceive | boolean | Yes | The value indicating whether to check for certificate revocation list on receive. | -| encryptionAlgorithm | enum | Yes | The encryption algorithm. - NotSpecified, None, DES3, RC2, AES128, AES192, AES256 | -| signingAlgorithm | enum | No | The signing algorithm. - NotSpecified, Default, SHA1, SHA2256, SHA2384, SHA2512 | - - - -### AS2EnvelopeSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageContentType | string | Yes | The message content type. | -| transmitFileNameInMimeHeader | boolean | Yes | The value indicating whether to transmit file name in mime header. | -| fileNameTemplate | string | Yes | The template for file name. | -| suspendMessageOnFileNameGenerationError | boolean | Yes | The value indicating whether to suspend message on file name generation error. | -| autogenerateFileName | boolean | Yes | The value indicating whether to auto generate file name. | - - - -### AS2ErrorSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| suspendDuplicateMessage | boolean | Yes | The value indicating whether to suspend duplicate message. | -| resendIfMdnNotReceived | boolean | Yes | The value indicating whether to resend message If MDN is not received. | - - - -### X12ValidationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| validateCharacterSet | boolean | Yes | The value indicating whether to validate character set in the message. | -| checkDuplicateInterchangeControlNumber | boolean | Yes | The value indicating whether to check for duplicate interchange control number. | -| interchangeControlNumberValidityDays | integer | Yes | The validity period of interchange control number. | -| checkDuplicateGroupControlNumber | boolean | Yes | The value indicating whether to check for duplicate group control number. | -| checkDuplicateTransactionSetControlNumber | boolean | Yes | The value indicating whether to check for duplicate transaction set control number. | -| validateEdiTypes | boolean | Yes | The value indicating whether to Whether to validate EDI types. | -| validateXsdTypes | boolean | Yes | The value indicating whether to Whether to validate XSD types. | -| allowLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to allow leading and trailing spaces and zeroes. | -| trimLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to trim leading and trailing spaces and zeroes. | -| trailingSeparatorPolicy | enum | Yes | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory | - - - -### X12FramingSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dataElementSeparator | integer | Yes | The data element separator. | -| componentSeparator | integer | Yes | The component separator. | -| replaceSeparatorsInPayload | boolean | Yes | The value indicating whether to replace separators in payload. | -| replaceCharacter | integer | Yes | The replacement character. | -| segmentTerminator | integer | Yes | The segment terminator. | -| characterSet | enum | Yes | The X12 character set. - NotSpecified, Basic, Extended, UTF8 | -| segmentTerminatorSuffix | enum | Yes | The segment terminator suffix. - NotSpecified, None, CR, LF, CRLF | - - - -### X12EnvelopeSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| controlStandardsId | integer | Yes | The controls standards id. | -| useControlStandardsIdAsRepetitionCharacter | boolean | Yes | The value indicating whether to use control standards id as repetition character. | -| senderApplicationId | string | Yes | The sender application id. | -| receiverApplicationId | string | Yes | The receiver application id. | -| controlVersionNumber | string | Yes | The control version number. | -| interchangeControlNumberLowerBound | integer | Yes | The interchange control number lower bound. | -| interchangeControlNumberUpperBound | integer | Yes | The interchange control number upper bound. | -| rolloverInterchangeControlNumber | boolean | Yes | The value indicating whether to rollover interchange control number. | -| enableDefaultGroupHeaders | boolean | Yes | The value indicating whether to enable default group headers. | -| functionalGroupId | string | No | The functional group id. | -| groupControlNumberLowerBound | integer | Yes | The group control number lower bound. | -| groupControlNumberUpperBound | integer | Yes | The group control number upper bound. | -| rolloverGroupControlNumber | boolean | Yes | The value indicating whether to rollover group control number. | -| groupHeaderAgencyCode | string | Yes | The group header agency code. | -| groupHeaderVersion | string | Yes | The group header version. | -| transactionSetControlNumberLowerBound | integer | Yes | The transaction set control number lower bound. | -| transactionSetControlNumberUpperBound | integer | Yes | The transaction set control number upper bound. | -| rolloverTransactionSetControlNumber | boolean | Yes | The value indicating whether to rollover transaction set control number. | -| transactionSetControlNumberPrefix | string | No | The transaction set control number prefix. | -| transactionSetControlNumberSuffix | string | No | The transaction set control number suffix. | -| overwriteExistingTransactionSetControlNumber | boolean | Yes | The value indicating whether to overwrite existing transaction set control number. | -| groupHeaderDateFormat | enum | Yes | The group header date format. - NotSpecified, CCYYMMDD, YYMMDD | -| groupHeaderTimeFormat | enum | Yes | The group header time format. - NotSpecified, HHMM, HHMMSS, HHMMSSdd, HHMMSSd | -| usageIndicator | enum | Yes | The usage indicator. - NotSpecified, Test, Information, Production | - - - -### X12AcknowledgementSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| needTechnicalAcknowledgement | boolean | Yes | The value indicating whether technical acknowledgement is needed. | -| batchTechnicalAcknowledgements | boolean | Yes | The value indicating whether to batch the technical acknowledgements. | -| needFunctionalAcknowledgement | boolean | Yes | The value indicating whether functional acknowledgement is needed. | -| functionalAcknowledgementVersion | string | No | The functional acknowledgement version. | -| batchFunctionalAcknowledgements | boolean | Yes | The value indicating whether to batch functional acknowledgements. | -| needImplementationAcknowledgement | boolean | Yes | The value indicating whether implementation acknowledgement is needed. | -| implementationAcknowledgementVersion | string | No | The implementation acknowledgement version. | -| batchImplementationAcknowledgements | boolean | Yes | The value indicating whether to batch implementation acknowledgements. | -| needLoopForValidMessages | boolean | Yes | The value indicating whether a loop is needed for valid messages. | -| sendSynchronousAcknowledgement | boolean | Yes | The value indicating whether to send synchronous acknowledgement. | -| acknowledgementControlNumberPrefix | string | No | The acknowledgement control number prefix. | -| acknowledgementControlNumberSuffix | string | No | The acknowledgement control number suffix. | -| acknowledgementControlNumberLowerBound | integer | Yes | The acknowledgement control number lower bound. | -| acknowledgementControlNumberUpperBound | integer | Yes | The acknowledgement control number upper bound. | -| rolloverAcknowledgementControlNumber | boolean | Yes | The value indicating whether to rollover acknowledgement control number. | - - - -### X12MessageFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageFilterType | enum | Yes | The message filter type. - NotSpecified, Include, Exclude | - - - -### X12SecuritySettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationQualifier | string | Yes | The authorization qualifier. | -| authorizationValue | string | No | The authorization value. | -| securityQualifier | string | Yes | The security qualifier. | -| passwordValue | string | No | The password value. | - - - -### X12ProcessingSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maskSecurityInfo | boolean | Yes | The value indicating whether to mask security information. | -| convertImpliedDecimal | boolean | Yes | The value indicating whether to convert numerical type to implied decimal. | -| preserveInterchange | boolean | Yes | The value indicating whether to preserve interchange. | -| suspendInterchangeOnError | boolean | Yes | The value indicating whether to suspend interchange on error. | -| createEmptyXmlTagsForTrailingSeparators | boolean | Yes | The value indicating whether to create empty xml tags for trailing separators. | -| useDotAsDecimalSeparator | boolean | Yes | The value indicating whether to use dot as decimal separator. | - - - -### X12EnvelopeOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| targetNamespace | string | Yes | The target namespace on which this envelope settings has to be applied. | -| protocolVersion | string | Yes | The protocol version on which this envelope settings has to be applied. | -| messageId | string | Yes | The message id on which this envelope settings has to be applied. | -| responsibleAgencyCode | string | Yes | The responsible agency code. | -| headerVersion | string | Yes | The header version. | -| senderApplicationId | string | Yes | The sender application id. | -| receiverApplicationId | string | Yes | The receiver application id. | -| functionalIdentifierCode | string | No | The functional identifier code. | -| dateFormat | enum | Yes | The date format. - NotSpecified, CCYYMMDD, YYMMDD | -| timeFormat | enum | Yes | The time format. - NotSpecified, HHMM, HHMMSS, HHMMSSdd, HHMMSSd | - - - -### X12ValidationOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | Yes | The message id on which the validation settings has to be applied. | -| validateEdiTypes | boolean | Yes | The value indicating whether to validate EDI types. | -| validateXsdTypes | boolean | Yes | The value indicating whether to validate XSD types. | -| allowLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to allow leading and trailing spaces and zeroes. | -| validateCharacterSet | boolean | Yes | The value indicating whether to validate character Set. | -| trimLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to trim leading and trailing spaces and zeroes. | -| trailingSeparatorPolicy | enum | Yes | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory | - - - -### X12MessageIdentifier object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | Yes | The message id. | - - - -### X12SchemaReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | Yes | The message id. | -| senderApplicationId | string | No | The sender application id. | -| schemaVersion | string | Yes | The schema version. | -| schemaName | string | Yes | The schema name. | - - - -### X12DelimiterOverrides object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocolVersion | string | No | The protocol version. | -| messageId | string | No | The message id. | -| dataElementSeparator | integer | Yes | The data element separator. | -| componentSeparator | integer | Yes | The component separator. | -| segmentTerminator | integer | Yes | The segment terminator. | -| segmentTerminatorSuffix | enum | Yes | The segment terminator suffix. - NotSpecified, None, CR, LF, CRLF | -| replaceCharacter | integer | Yes | The replacement character. | -| replaceSeparatorsInPayload | boolean | Yes | The value indicating whether to replace separators in payload. | -| targetNamespace | string | No | The target namespace on which this delimiter settings has to be applied. | - - - -### EdifactValidationSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| validateCharacterSet | boolean | Yes | The value indicating whether to validate character set in the message. | -| checkDuplicateInterchangeControlNumber | boolean | Yes | The value indicating whether to check for duplicate interchange control number. | -| interchangeControlNumberValidityDays | integer | Yes | The validity period of interchange control number. | -| checkDuplicateGroupControlNumber | boolean | Yes | The value indicating whether to check for duplicate group control number. | -| checkDuplicateTransactionSetControlNumber | boolean | Yes | The value indicating whether to check for duplicate transaction set control number. | -| validateEdiTypes | boolean | Yes | The value indicating whether to Whether to validate EDI types. | -| validateXsdTypes | boolean | Yes | The value indicating whether to Whether to validate XSD types. | -| allowLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to allow leading and trailing spaces and zeroes. | -| trimLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to trim leading and trailing spaces and zeroes. | -| trailingSeparatorPolicy | enum | Yes | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory | - - - -### EdifactFramingSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceCodeListDirectoryVersion | string | No | The service code list directory version. | -| characterEncoding | string | No | The character encoding. | -| protocolVersion | integer | Yes | The protocol version. | -| dataElementSeparator | integer | Yes | The data element separator. | -| componentSeparator | integer | Yes | The component separator. | -| segmentTerminator | integer | Yes | The segment terminator. | -| releaseIndicator | integer | Yes | The release indicator. | -| repetitionSeparator | integer | Yes | The repetition separator. | -| characterSet | enum | Yes | The EDIFACT frame setting characterSet. - NotSpecified, UNOB, UNOA, UNOC, UNOD, UNOE, UNOF, UNOG, UNOH, UNOI, UNOJ, UNOK, UNOX, UNOY, KECA | -| decimalPointIndicator | enum | Yes | The EDIFACT frame setting decimal indicator. - NotSpecified, Comma, Decimal | -| segmentTerminatorSuffix | enum | Yes | The EDIFACT frame setting segment terminator suffix. - NotSpecified, None, CR, LF, CRLF | - - - -### EdifactEnvelopeSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| groupAssociationAssignedCode | string | No | The group association assigned code. | -| communicationAgreementId | string | No | The communication agreement id. | -| applyDelimiterStringAdvice | boolean | Yes | The value indicating whether to apply delimiter string advice. | -| createGroupingSegments | boolean | Yes | The value indicating whether to create grouping segments. | -| enableDefaultGroupHeaders | boolean | Yes | The value indicating whether to enable default group headers. | -| recipientReferencePasswordValue | string | No | The recipient reference password value. | -| recipientReferencePasswordQualifier | string | No | The recipient reference password qualifier. | -| applicationReferenceId | string | No | The application reference id. | -| processingPriorityCode | string | No | The processing priority code. | -| interchangeControlNumberLowerBound | integer | Yes | The interchange control number lower bound. | -| interchangeControlNumberUpperBound | integer | Yes | The interchange control number upper bound. | -| rolloverInterchangeControlNumber | boolean | Yes | The value indicating whether to rollover interchange control number. | -| interchangeControlNumberPrefix | string | No | The interchange control number prefix. | -| interchangeControlNumberSuffix | string | No | The interchange control number suffix. | -| senderReverseRoutingAddress | string | No | The sender reverse routing address. | -| receiverReverseRoutingAddress | string | No | The receiver reverse routing address. | -| functionalGroupId | string | No | The functional group id. | -| groupControllingAgencyCode | string | No | The group controlling agency code. | -| groupMessageVersion | string | No | The group message version. | -| groupMessageRelease | string | No | The group message release. | -| groupControlNumberLowerBound | integer | Yes | The group control number lower bound. | -| groupControlNumberUpperBound | integer | Yes | The group control number upper bound. | -| rolloverGroupControlNumber | boolean | Yes | The value indicating whether to rollover group control number. | -| groupControlNumberPrefix | string | No | The group control number prefix. | -| groupControlNumberSuffix | string | No | The group control number suffix. | -| groupApplicationReceiverQualifier | string | No | The group application receiver qualifier. | -| groupApplicationReceiverId | string | No | The group application receiver id. | -| groupApplicationSenderQualifier | string | No | The group application sender qualifier. | -| groupApplicationSenderId | string | No | The group application sender id. | -| groupApplicationPassword | string | No | The group application password. | -| overwriteExistingTransactionSetControlNumber | boolean | Yes | The value indicating whether to overwrite existing transaction set control number. | -| transactionSetControlNumberPrefix | string | No | The transaction set control number prefix. | -| transactionSetControlNumberSuffix | string | No | The transaction set control number suffix. | -| transactionSetControlNumberLowerBound | integer | Yes | The transaction set control number lower bound. | -| transactionSetControlNumberUpperBound | integer | Yes | The transaction set control number upper bound. | -| rolloverTransactionSetControlNumber | boolean | Yes | The value indicating whether to rollover transaction set control number. | -| isTestInterchange | boolean | Yes | The value indicating whether the message is a test interchange. | -| senderInternalIdentification | string | No | The sender internal identification. | -| senderInternalSubIdentification | string | No | The sender internal sub identification. | -| receiverInternalIdentification | string | No | The receiver internal identification. | -| receiverInternalSubIdentification | string | No | The receiver internal sub identification. | - - - -### EdifactAcknowledgementSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| needTechnicalAcknowledgement | boolean | Yes | The value indicating whether technical acknowledgement is needed. | -| batchTechnicalAcknowledgements | boolean | Yes | The value indicating whether to batch the technical acknowledgements. | -| needFunctionalAcknowledgement | boolean | Yes | The value indicating whether functional acknowledgement is needed. | -| batchFunctionalAcknowledgements | boolean | Yes | The value indicating whether to batch functional acknowledgements. | -| needLoopForValidMessages | boolean | Yes | The value indicating whether a loop is needed for valid messages. | -| sendSynchronousAcknowledgement | boolean | Yes | The value indicating whether to send synchronous acknowledgement. | -| acknowledgementControlNumberPrefix | string | No | The acknowledgement control number prefix. | -| acknowledgementControlNumberSuffix | string | No | The acknowledgement control number suffix. | -| acknowledgementControlNumberLowerBound | integer | Yes | The acknowledgement control number lower bound. | -| acknowledgementControlNumberUpperBound | integer | Yes | The acknowledgement control number upper bound. | -| rolloverAcknowledgementControlNumber | boolean | Yes | The value indicating whether to rollover acknowledgement control number. | - - - -### EdifactMessageFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageFilterType | enum | Yes | The message filter type. - NotSpecified, Include, Exclude | - - - -### EdifactProcessingSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maskSecurityInfo | boolean | Yes | The value indicating whether to mask security information. | -| preserveInterchange | boolean | Yes | The value indicating whether to preserve interchange. | -| suspendInterchangeOnError | boolean | Yes | The value indicating whether to suspend interchange on error. | -| createEmptyXmlTagsForTrailingSeparators | boolean | Yes | The value indicating whether to create empty xml tags for trailing separators. | -| useDotAsDecimalSeparator | boolean | Yes | The value indicating whether to use dot as decimal separator. | - - - -### EdifactEnvelopeOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id on which this envelope settings has to be applied. | -| messageVersion | string | No | The message version on which this envelope settings has to be applied. | -| messageRelease | string | No | The message release version on which this envelope settings has to be applied. | -| messageAssociationAssignedCode | string | No | The message association assigned code. | -| targetNamespace | string | No | The target namespace on which this envelope settings has to be applied. | -| functionalGroupId | string | No | The functional group id. | -| senderApplicationQualifier | string | No | The sender application qualifier. | -| senderApplicationId | string | No | The sender application id. | -| receiverApplicationQualifier | string | No | The receiver application qualifier. | -| receiverApplicationId | string | No | The receiver application id. | -| controllingAgencyCode | string | No | The controlling agency code. | -| groupHeaderMessageVersion | string | No | The group header message version. | -| groupHeaderMessageRelease | string | No | The group header message release. | -| associationAssignedCode | string | No | The association assigned code. | -| applicationPassword | string | No | The application password. | - - - -### EdifactMessageIdentifier object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | Yes | The message id on which this envelope settings has to be applied. | - - - -### EdifactSchemaReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | Yes | The message id. | -| messageVersion | string | Yes | The message version. | -| messageRelease | string | Yes | The message release version. | -| senderApplicationId | string | No | The sender application id. | -| senderApplicationQualifier | string | No | The sender application qualifier. | -| associationAssignedCode | string | No | The association assigned code. | -| schemaName | string | Yes | The schema name. | - - - -### EdifactValidationOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | Yes | The message id on which the validation settings has to be applied. | -| enforceCharacterSet | boolean | Yes | The value indicating whether to validate character Set. | -| validateEdiTypes | boolean | Yes | The value indicating whether to validate EDI types. | -| validateXsdTypes | boolean | Yes | The value indicating whether to validate XSD types. | -| allowLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to allow leading and trailing spaces and zeroes. | -| trailingSeparatorPolicy | enum | Yes | The trailing separator policy. - NotSpecified, NotAllowed, Optional, Mandatory | -| trimLeadingAndTrailingSpacesAndZeroes | boolean | Yes | The value indicating whether to trim leading and trailing spaces and zeroes. | - - - -### EdifactDelimiterOverride object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| messageId | string | No | The message id. | -| messageVersion | string | No | The message version. | -| messageRelease | string | No | The message releaseversion. | -| dataElementSeparator | integer | Yes | The data element separator. | -| componentSeparator | integer | Yes | The component separator. | -| segmentTerminator | integer | Yes | The segment terminator. | -| repetitionSeparator | integer | Yes | The repetition separator. | -| segmentTerminatorSuffix | enum | Yes | The segment terminator suffix. - NotSpecified, None, CR, LF, CRLF | -| decimalPointIndicator | enum | Yes | The decimal point indicator. - NotSpecified, Comma, Decimal | -| releaseIndicator | integer | Yes | The release indicator. | -| messageAssociationAssignedCode | string | No | The message association assigned code. | -| targetNamespace | string | No | The target namespace on which this delimiter settings has to be applied. | - diff --git a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/certificates.md b/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/certificates.md deleted file mode 100644 index d721bf7..0000000 --- a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/certificates.md +++ /dev/null @@ -1,66 +0,0 @@ -# Microsoft.Logic/integrationAccounts/certificates template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Logic/integrationAccounts/certificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/certificates", - "apiVersion": "2016-06-01", - "location": "string", - "tags": {}, - "properties": { - "metadata": {}, - "key": { - "keyVault": { - "id": "string" - }, - "keyName": "string", - "keyVersion": "string" - }, - "publicCertificate": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/certificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/certificates | -| apiVersion | enum | Yes | 2016-06-01 | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account certificate properties. - [IntegrationAccountCertificateProperties object](#IntegrationAccountCertificateProperties) | - - - -### IntegrationAccountCertificateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| metadata | object | No | The metadata. | -| key | object | No | The key details in the key vault. - [KeyVaultKeyReference object](#KeyVaultKeyReference) | -| publicCertificate | string | No | The public certificate. | - - - -### KeyVaultKeyReference object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyVault | object | Yes | The key vault reference. - [KeyVaultKeyReferenceKeyVault object](#KeyVaultKeyReferenceKeyVault) | -| keyName | string | Yes | The private key name in key vault. | -| keyVersion | string | No | The private key version in key vault. | - - - -### KeyVaultKeyReferenceKeyVault object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | The resource id. | - diff --git a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/maps.md b/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/maps.md deleted file mode 100644 index b29bd03..0000000 --- a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/maps.md +++ /dev/null @@ -1,57 +0,0 @@ -# Microsoft.Logic/integrationAccounts/maps template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Logic/integrationAccounts/maps resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/maps", - "apiVersion": "2016-06-01", - "location": "string", - "tags": {}, - "properties": { - "mapType": "string", - "parametersSchema": { - "ref": "string" - }, - "content": "string", - "contentType": "string", - "metadata": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/maps object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/maps | -| apiVersion | enum | Yes | 2016-06-01 | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account map properties. - [IntegrationAccountMapProperties object](#IntegrationAccountMapProperties) | - - - -### IntegrationAccountMapProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| mapType | enum | Yes | The map type. - NotSpecified or Xslt | -| parametersSchema | object | No | The parameters schema of integration account map. - [IntegrationAccountMapPropertiesParametersSchema object](#IntegrationAccountMapPropertiesParametersSchema) | -| content | string | No | The content. | -| contentType | string | No | The content type. | -| metadata | object | No | The metadata. | - - - -### IntegrationAccountMapPropertiesParametersSchema object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ref | string | No | The reference name. | - diff --git a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/partners.md b/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/partners.md deleted file mode 100644 index 19f3682..0000000 --- a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/partners.md +++ /dev/null @@ -1,75 +0,0 @@ -# Microsoft.Logic/integrationAccounts/partners template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Logic/integrationAccounts/partners resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/partners", - "apiVersion": "2016-06-01", - "location": "string", - "tags": {}, - "properties": { - "partnerType": "string", - "metadata": {}, - "content": { - "b2b": { - "businessIdentities": [ - { - "qualifier": "string", - "value": "string" - } - ] - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/partners object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/partners | -| apiVersion | enum | Yes | 2016-06-01 | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account partner properties. - [IntegrationAccountPartnerProperties object](#IntegrationAccountPartnerProperties) | - - - -### IntegrationAccountPartnerProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| partnerType | enum | Yes | The partner type. - NotSpecified or B2B | -| metadata | object | No | The metadata. | -| content | object | Yes | The partner content. - [PartnerContent object](#PartnerContent) | - - - -### PartnerContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| b2b | object | No | The B2B partner content. - [B2BPartnerContent object](#B2BPartnerContent) | - - - -### B2BPartnerContent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| businessIdentities | array | No | The list of partner business identities. - [BusinessIdentity object](#BusinessIdentity) | - - - -### BusinessIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| qualifier | string | Yes | The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 | -| value | string | Yes | The user defined business identity value. | - diff --git a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/schemas.md b/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/schemas.md deleted file mode 100644 index b039a3f..0000000 --- a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/schemas.md +++ /dev/null @@ -1,52 +0,0 @@ -# Microsoft.Logic/integrationAccounts/schemas template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Logic/integrationAccounts/schemas resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/schemas", - "apiVersion": "2016-06-01", - "location": "string", - "tags": {}, - "properties": { - "schemaType": "string", - "targetNamespace": "string", - "documentName": "string", - "fileName": "string", - "metadata": {}, - "content": "string", - "contentType": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/schemas object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/schemas | -| apiVersion | enum | Yes | 2016-06-01 | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account schema properties. - [IntegrationAccountSchemaProperties object](#IntegrationAccountSchemaProperties) | - - - -### IntegrationAccountSchemaProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| schemaType | enum | Yes | The schema type. - NotSpecified or Xml | -| targetNamespace | string | No | The target namespace of the schema. | -| documentName | string | No | The document name. | -| fileName | string | No | The file name. | -| metadata | object | No | The metadata. | -| content | string | No | The content. | -| contentType | string | No | The content type. | - diff --git a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/sessions.md b/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/sessions.md deleted file mode 100644 index 5a3dc3c..0000000 --- a/test/Resource/Expected/Logic/2016-06-01/integrationAccounts/sessions.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Logic/integrationAccounts/sessions template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Logic/integrationAccounts/sessions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/integrationAccounts/sessions", - "apiVersion": "2016-06-01", - "location": "string", - "tags": {}, - "properties": { - "content": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/integrationAccounts/sessions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/integrationAccounts/sessions | -| apiVersion | enum | Yes | 2016-06-01 | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The integration account session properties. - [IntegrationAccountSessionProperties object](#IntegrationAccountSessionProperties) | - - - -### IntegrationAccountSessionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| content | object | No | The session content. | - diff --git a/test/Resource/Expected/Logic/2016-06-01/workflows.md b/test/Resource/Expected/Logic/2016-06-01/workflows.md deleted file mode 100644 index 500214b..0000000 --- a/test/Resource/Expected/Logic/2016-06-01/workflows.md +++ /dev/null @@ -1,59 +0,0 @@ -# Microsoft.Logic/workflows template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Logic/workflows resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Logic/workflows", - "apiVersion": "2016-06-01", - "location": "string", - "tags": {}, - "properties": { - "state": "string", - "sku": { - "name": "string", - "plan": {} - }, - "integrationAccount": {}, - "definition": {}, - "parameters": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Logic/workflows object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Logic/workflows | -| apiVersion | enum | Yes | 2016-06-01 | -| location | string | No | The resource location. | -| tags | object | No | The resource tags. | -| properties | object | Yes | The workflow properties. - [WorkflowProperties object](#WorkflowProperties) | - - - -### WorkflowProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| state | enum | No | The state. - NotSpecified, Completed, Enabled, Disabled, Deleted, Suspended | -| sku | object | No | The sku. - [Sku object](#Sku) | -| integrationAccount | object | No | The integration account. - [ResourceReference object](#ResourceReference) | -| definition | object | No | The definition. | -| parameters | object | No | The parameters. | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The name. - NotSpecified, Free, Shared, Basic, Standard, Premium | -| plan | object | No | The reference to plan. - [ResourceReference object](#ResourceReference) | - diff --git a/test/Resource/Expected/Microsoft.BotService/2017-12-01/Microsoft.BotService.json b/test/Resource/Expected/Microsoft.BotService/2017-12-01/Microsoft.BotService.json new file mode 100644 index 0000000..2dcd3ca --- /dev/null +++ b/test/Resource/Expected/Microsoft.BotService/2017-12-01/Microsoft.BotService.json @@ -0,0 +1,1513 @@ +{ + "id": "https://schema.management.azure.com/schemas/2017-12-01/Microsoft.BotService.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.BotService", + "description": "Microsoft BotService Resource Types", + "resourceDefinitions": { + "botServices": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Bot resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.BotService/botServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-12-01" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/BotProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Bot." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/botServices_channels_childResource" + }, + { + "$ref": "#/definitions/botServices_Connections_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices" + }, + "botServices_channels": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FacebookChannel", + "EmailChannel", + "KikChannel", + "TelegramChannel", + "SlackChannel", + "MsTeamsChannel", + "SkypeChannel", + "WebChatChannel", + "DirectLineChannel", + "SmsChannel" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Channel resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.BotService/botServices/channels" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-12-01" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/Channel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Channel definition" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices/channels" + }, + "botServices_Connections": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Bot Service Connection Setting resource" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.BotService/botServices/Connections" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-12-01" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ConnectionSettingProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties for a Connection Setting Item" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices/Connections" + } + }, + "definitions": { + "BotProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The Name of the bot" + }, + "description": { + "type": "string", + "description": "The description of the bot" + }, + "iconUrl": { + "type": "string", + "description": "The Icon Url of the bot" + }, + "endpoint": { + "type": "string", + "description": "The bot's endpoint" + }, + "msaAppId": { + "type": "string", + "description": "Microsoft App Id for the bot" + }, + "developerAppInsightKey": { + "type": "string", + "description": "The Application Insights key" + }, + "developerAppInsightsApiKey": { + "type": "string", + "description": "The Application Insights Api Key" + }, + "developerAppInsightsApplicationId": { + "type": "string", + "description": "The Application Insights App Id" + }, + "luisAppIds": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of LUIS App Ids" + }, + "luisKey": { + "type": "string", + "description": "The LUIS Key" + } + }, + "required": [ + "displayName", + "endpoint", + "msaAppId" + ], + "description": "The parameters to provide for the Bot." + }, + "botServices_channels_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FacebookChannel", + "EmailChannel", + "KikChannel", + "TelegramChannel", + "SlackChannel", + "MsTeamsChannel", + "SkypeChannel", + "WebChatChannel", + "DirectLineChannel", + "SmsChannel" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Channel resource." + }, + "type": { + "type": "string", + "enum": [ + "channels" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-12-01" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/Channel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Channel definition" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices/channels" + }, + "botServices_Connections_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Bot Service Connection Setting resource" + }, + "type": { + "type": "string", + "enum": [ + "Connections" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-12-01" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ConnectionSettingProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties for a Connection Setting Item" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices/Connections" + }, + "Channel": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/FacebookChannel" + }, + { + "$ref": "#/definitions/EmailChannel" + }, + { + "$ref": "#/definitions/MsTeamsChannel" + }, + { + "$ref": "#/definitions/SkypeChannel" + }, + { + "$ref": "#/definitions/KikChannel" + }, + { + "$ref": "#/definitions/WebChatChannel" + }, + { + "$ref": "#/definitions/DirectLineChannel" + }, + { + "$ref": "#/definitions/TelegramChannel" + }, + { + "$ref": "#/definitions/SmsChannel" + }, + { + "$ref": "#/definitions/SlackChannel" + } + ], + "properties": {}, + "description": "Channel definition" + }, + "ConnectionSettingParameter": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Key for the Connection Setting Parameter." + }, + "value": { + "type": "string", + "description": "Value associated with the Connection Setting Parameter." + } + }, + "description": "Extra Parameter in a Connection Setting Properties to indicate service provider specific properties" + }, + "ConnectionSettingProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Client Id associated with the Connection Setting." + }, + "clientSecret": { + "type": "string", + "description": "Client Secret associated with the Connection Setting" + }, + "scopes": { + "type": "string", + "description": "Scopes associated with the Connection Setting" + }, + "serviceProviderId": { + "type": "string", + "description": "Service Provider Id associated with the Connection Setting" + }, + "serviceProviderDisplayName": { + "type": "string", + "description": "Service Provider Display Name associated with the Connection Setting" + }, + "parameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionSettingParameter" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Service Provider Parameters associated with the Connection Setting" + } + }, + "description": "Properties for a Connection Setting Item" + }, + "DirectLineChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DirectLineChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Direct Line channel." + }, + "channelName": { + "type": "string", + "enum": [ + "DirectLineChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Direct Line channel definition" + }, + "DirectLineChannelProperties": { + "type": "object", + "properties": { + "sites": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DirectLineSite" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Direct Line sites" + } + }, + "description": "The parameters to provide for the Direct Line channel." + }, + "DirectLineSite": { + "type": "object", + "properties": { + "siteName": { + "type": "string", + "description": "Site name" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for DirectLine channel" + }, + "isV1Enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for Bot Framework V1 protocol" + }, + "isV3Enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for Bot Framework V1 protocol" + } + }, + "required": [ + "siteName", + "isEnabled", + "isV1Enabled", + "isV3Enabled" + ], + "description": "A site for the Direct Line channel" + }, + "EmailChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EmailChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Email channel." + }, + "channelName": { + "type": "string", + "enum": [ + "EmailChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Email channel definition" + }, + "EmailChannelProperties": { + "type": "object", + "properties": { + "emailAddress": { + "type": "string", + "description": "The email address" + }, + "password": { + "type": "string", + "description": "The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "emailAddress", + "password", + "isEnabled" + ], + "description": "The parameters to provide for the Email channel." + }, + "FacebookChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/FacebookChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Facebook channel." + }, + "channelName": { + "type": "string", + "enum": [ + "FacebookChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Facebook channel definition" + }, + "FacebookChannelProperties": { + "type": "object", + "properties": { + "pages": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/FacebookPage" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Facebook pages" + }, + "appId": { + "type": "string", + "description": "Facebook application id" + }, + "appSecret": { + "type": "string", + "description": "Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "appId", + "appSecret", + "isEnabled" + ], + "description": "The parameters to provide for the Facebook channel." + }, + "FacebookPage": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Page id" + }, + "accessToken": { + "type": "string", + "description": "Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty." + } + }, + "required": [ + "id", + "accessToken" + ], + "description": "A Facebook page for Facebook channel registration" + }, + "KikChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/KikChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Kik channel." + }, + "channelName": { + "type": "string", + "enum": [ + "KikChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Kik channel definition" + }, + "KikChannelProperties": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "The Kik user name" + }, + "apiKey": { + "type": "string", + "description": "Kik API key. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "userName", + "apiKey", + "isEnabled" + ], + "description": "The parameters to provide for the Kik channel." + }, + "MsTeamsChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MsTeamsChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Microsoft Teams channel." + }, + "channelName": { + "type": "string", + "enum": [ + "MsTeamsChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Microsoft Teams channel definition" + }, + "MsTeamsChannelProperties": { + "type": "object", + "properties": { + "enableMessaging": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable messaging for Microsoft Teams channel" + }, + "enableMediaCards": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable media cards for Microsoft Teams channel" + }, + "enableVideo": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable video for Microsoft Teams channel" + }, + "enableCalling": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable calling for Microsoft Teams channel" + }, + "callMode": { + "type": "string", + "description": "Enable messaging for Microsoft Teams channel" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "isEnabled" + ], + "description": "The parameters to provide for the Microsoft Teams channel." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "F0", + "S1" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "required": [ + "name" + ], + "description": "The SKU of the cognitive services account." + }, + "SkypeChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SkypeChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Microsoft Teams channel." + }, + "channelName": { + "type": "string", + "enum": [ + "SkypeChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Skype channel definition" + }, + "SkypeChannelProperties": { + "type": "object", + "properties": { + "enableMessaging": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable messaging for Skype channel" + }, + "enableMediaCards": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable media cards for Skype channel" + }, + "enableVideo": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable video for Skype channel" + }, + "enableCalling": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable calling for Skype channel" + }, + "enableScreenSharing": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable screen sharing for Skype channel" + }, + "enableGroups": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable groups for Skype channel" + }, + "groupsMode": { + "type": "string", + "description": "Group mode for Skype channel" + }, + "callingWebHook": { + "type": "string", + "description": "Calling web hook for Skype channel" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "isEnabled" + ], + "description": "The parameters to provide for the Microsoft Teams channel." + }, + "SlackChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SlackChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Slack channel." + }, + "channelName": { + "type": "string", + "enum": [ + "SlackChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Slack channel definition" + }, + "SlackChannelProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The Slack client id" + }, + "clientSecret": { + "type": "string", + "description": "The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "verificationToken": { + "type": "string", + "description": "The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "landingPageUrl": { + "type": "string", + "description": "The Slack landing page Url" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "clientId", + "clientSecret", + "verificationToken", + "isEnabled" + ], + "description": "The parameters to provide for the Slack channel." + }, + "SmsChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SmsChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Sms channel." + }, + "channelName": { + "type": "string", + "enum": [ + "SmsChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Sms channel definition" + }, + "SmsChannelProperties": { + "type": "object", + "properties": { + "phone": { + "type": "string", + "description": "The Sms phone" + }, + "accountSID": { + "type": "string", + "description": "The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "authToken": { + "type": "string", + "description": "The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "phone", + "accountSID", + "authToken", + "isEnabled" + ], + "description": "The parameters to provide for the Sms channel." + }, + "TelegramChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TelegramChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Telegram channel." + }, + "channelName": { + "type": "string", + "enum": [ + "TelegramChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Telegram channel definition" + }, + "TelegramChannelProperties": { + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "description": "The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "accessToken", + "isEnabled" + ], + "description": "The parameters to provide for the Telegram channel." + }, + "WebChatChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/WebChatChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Web Chat channel." + }, + "channelName": { + "type": "string", + "enum": [ + "WebChatChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Web Chat channel definition" + }, + "WebChatChannelProperties": { + "type": "object", + "properties": { + "sites": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/WebChatSite" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Web Chat sites" + } + }, + "description": "The parameters to provide for the Web Chat channel." + }, + "WebChatSite": { + "type": "object", + "properties": { + "siteName": { + "type": "string", + "description": "Site name" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for DirectLine channel" + }, + "enablePreview": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for preview versions of Webchat" + } + }, + "required": [ + "siteName", + "isEnabled", + "enablePreview" + ], + "description": "A site for the Webchat channel" + } + } +} diff --git a/test/Resource/Expected/Microsoft.BotService/2018-07-12/Microsoft.BotService.json b/test/Resource/Expected/Microsoft.BotService/2018-07-12/Microsoft.BotService.json new file mode 100644 index 0000000..0f3f30a --- /dev/null +++ b/test/Resource/Expected/Microsoft.BotService/2018-07-12/Microsoft.BotService.json @@ -0,0 +1,1695 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-07-12/Microsoft.BotService.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.BotService", + "description": "Microsoft BotService Resource Types", + "resourceDefinitions": { + "botServices": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Bot resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.BotService/botServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-12" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/BotProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Bot." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/botServices_channels_childResource" + }, + { + "$ref": "#/definitions/botServices_Connections_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices" + }, + "botServices_channels": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FacebookChannel", + "EmailChannel", + "KikChannel", + "TelegramChannel", + "SlackChannel", + "MsTeamsChannel", + "SkypeChannel", + "WebChatChannel", + "DirectLineChannel", + "SmsChannel" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Channel resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.BotService/botServices/channels" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-12" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/Channel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Channel definition" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices/channels" + }, + "botServices_Connections": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Bot Service Connection Setting resource" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.BotService/botServices/Connections" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-12" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ConnectionSettingProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties for a Connection Setting Item" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices/Connections" + }, + "enterpriseChannels": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Bot resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.BotService/enterpriseChannels" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-12" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EnterpriseChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Enterprise Channel." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/enterpriseChannels" + } + }, + "definitions": { + "BotProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The Name of the bot" + }, + "description": { + "type": "string", + "description": "The description of the bot" + }, + "iconUrl": { + "type": "string", + "description": "The Icon Url of the bot" + }, + "endpoint": { + "type": "string", + "description": "The bot's endpoint" + }, + "msaAppId": { + "type": "string", + "description": "Microsoft App Id for the bot" + }, + "developerAppInsightKey": { + "type": "string", + "description": "The Application Insights key" + }, + "developerAppInsightsApiKey": { + "type": "string", + "description": "The Application Insights Api Key" + }, + "developerAppInsightsApplicationId": { + "type": "string", + "description": "The Application Insights App Id" + }, + "luisAppIds": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of LUIS App Ids" + }, + "luisKey": { + "type": "string", + "description": "The LUIS Key" + } + }, + "required": [ + "displayName", + "endpoint", + "msaAppId" + ], + "description": "The parameters to provide for the Bot." + }, + "botServices_channels_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FacebookChannel", + "EmailChannel", + "KikChannel", + "TelegramChannel", + "SlackChannel", + "MsTeamsChannel", + "SkypeChannel", + "WebChatChannel", + "DirectLineChannel", + "SmsChannel" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Channel resource." + }, + "type": { + "type": "string", + "enum": [ + "channels" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-12" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/Channel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Channel definition" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices/channels" + }, + "botServices_Connections_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the Bot Service Connection Setting resource" + }, + "type": { + "type": "string", + "enum": [ + "Connections" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-12" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the cognitive services account." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ConnectionSettingProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties for a Connection Setting Item" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.BotService/botServices/Connections" + }, + "Channel": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/FacebookChannel" + }, + { + "$ref": "#/definitions/EmailChannel" + }, + { + "$ref": "#/definitions/MsTeamsChannel" + }, + { + "$ref": "#/definitions/SkypeChannel" + }, + { + "$ref": "#/definitions/KikChannel" + }, + { + "$ref": "#/definitions/WebChatChannel" + }, + { + "$ref": "#/definitions/DirectLineChannel" + }, + { + "$ref": "#/definitions/TelegramChannel" + }, + { + "$ref": "#/definitions/SmsChannel" + }, + { + "$ref": "#/definitions/SlackChannel" + } + ], + "properties": {}, + "description": "Channel definition" + }, + "ConnectionSettingParameter": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Key for the Connection Setting Parameter." + }, + "value": { + "type": "string", + "description": "Value associated with the Connection Setting Parameter." + } + }, + "description": "Extra Parameter in a Connection Setting Properties to indicate service provider specific properties" + }, + "ConnectionSettingProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Client Id associated with the Connection Setting." + }, + "clientSecret": { + "type": "string", + "description": "Client Secret associated with the Connection Setting" + }, + "scopes": { + "type": "string", + "description": "Scopes associated with the Connection Setting" + }, + "serviceProviderId": { + "type": "string", + "description": "Service Provider Id associated with the Connection Setting" + }, + "serviceProviderDisplayName": { + "type": "string", + "description": "Service Provider Display Name associated with the Connection Setting" + }, + "parameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionSettingParameter" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Service Provider Parameters associated with the Connection Setting" + } + }, + "description": "Properties for a Connection Setting Item" + }, + "DirectLineChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DirectLineChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Direct Line channel." + }, + "channelName": { + "type": "string", + "enum": [ + "DirectLineChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Direct Line channel definition" + }, + "DirectLineChannelProperties": { + "type": "object", + "properties": { + "sites": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DirectLineSite" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Direct Line sites" + } + }, + "description": "The parameters to provide for the Direct Line channel." + }, + "DirectLineSite": { + "type": "object", + "properties": { + "siteName": { + "type": "string", + "description": "Site name" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for DirectLine channel." + }, + "isV1Enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for Bot Framework V1 protocol." + }, + "isV3Enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for Bot Framework V1 protocol." + }, + "isSecureSiteEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for authentication with Bot Framework." + }, + "trustedOrigins": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True." + } + }, + "required": [ + "siteName", + "isEnabled", + "isV1Enabled", + "isV3Enabled" + ], + "description": "A site for the Direct Line channel" + }, + "EmailChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EmailChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Email channel." + }, + "channelName": { + "type": "string", + "enum": [ + "EmailChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Email channel definition" + }, + "EmailChannelProperties": { + "type": "object", + "properties": { + "emailAddress": { + "type": "string", + "description": "The email address" + }, + "password": { + "type": "string", + "description": "The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "emailAddress", + "password", + "isEnabled" + ], + "description": "The parameters to provide for the Email channel." + }, + "EnterpriseChannelNode": { + "type": "object", + "properties": { + "state": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Creating", + "CreateFailed", + "Started", + "Starting", + "StartFailed", + "Stopped", + "Stopping", + "StopFailed", + "Deleting", + "DeleteFailed" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The current state of the Enterprise Channel Node." + }, + "name": { + "type": "string", + "description": "The name of the Enterprise Channel Node." + }, + "azureSku": { + "type": "string", + "description": "The sku of the Enterprise Channel Node." + }, + "azureLocation": { + "type": "string", + "description": "The location of the Enterprise Channel Node." + } + }, + "required": [ + "name", + "azureSku", + "azureLocation" + ], + "description": "The properties specific to an Enterprise Channel Node." + }, + "EnterpriseChannelProperties": { + "type": "object", + "properties": { + "state": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Creating", + "CreateFailed", + "Started", + "Starting", + "StartFailed", + "Stopped", + "Stopping", + "StopFailed", + "Deleting", + "DeleteFailed" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The current state of the Enterprise Channel." + }, + "nodes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EnterpriseChannelNode" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The nodes associated with the Enterprise Channel." + } + }, + "required": [ + "nodes" + ], + "description": "The parameters to provide for the Enterprise Channel." + }, + "FacebookChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/FacebookChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Facebook channel." + }, + "channelName": { + "type": "string", + "enum": [ + "FacebookChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Facebook channel definition" + }, + "FacebookChannelProperties": { + "type": "object", + "properties": { + "pages": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/FacebookPage" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Facebook pages" + }, + "appId": { + "type": "string", + "description": "Facebook application id" + }, + "appSecret": { + "type": "string", + "description": "Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "appId", + "appSecret", + "isEnabled" + ], + "description": "The parameters to provide for the Facebook channel." + }, + "FacebookPage": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Page id" + }, + "accessToken": { + "type": "string", + "description": "Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty." + } + }, + "required": [ + "id", + "accessToken" + ], + "description": "A Facebook page for Facebook channel registration" + }, + "KikChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/KikChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Kik channel." + }, + "channelName": { + "type": "string", + "enum": [ + "KikChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Kik channel definition" + }, + "KikChannelProperties": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "The Kik user name" + }, + "apiKey": { + "type": "string", + "description": "Kik API key. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "userName", + "apiKey", + "isEnabled" + ], + "description": "The parameters to provide for the Kik channel." + }, + "MsTeamsChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MsTeamsChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Microsoft Teams channel." + }, + "channelName": { + "type": "string", + "enum": [ + "MsTeamsChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Microsoft Teams channel definition" + }, + "MsTeamsChannelProperties": { + "type": "object", + "properties": { + "enableCalling": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable calling for Microsoft Teams channel" + }, + "callingWebHook": { + "type": "string", + "description": "Webhook for Microsoft Teams channel calls" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "isEnabled" + ], + "description": "The parameters to provide for the Microsoft Teams channel." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "F0", + "S1" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "required": [ + "name" + ], + "description": "The SKU of the cognitive services account." + }, + "SkypeChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SkypeChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Microsoft Teams channel." + }, + "channelName": { + "type": "string", + "enum": [ + "SkypeChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Skype channel definition" + }, + "SkypeChannelProperties": { + "type": "object", + "properties": { + "enableMessaging": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable messaging for Skype channel" + }, + "enableMediaCards": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable media cards for Skype channel" + }, + "enableVideo": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable video for Skype channel" + }, + "enableCalling": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable calling for Skype channel" + }, + "enableScreenSharing": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable screen sharing for Skype channel" + }, + "enableGroups": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable groups for Skype channel" + }, + "groupsMode": { + "type": "string", + "description": "Group mode for Skype channel" + }, + "callingWebHook": { + "type": "string", + "description": "Calling web hook for Skype channel" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "isEnabled" + ], + "description": "The parameters to provide for the Microsoft Teams channel." + }, + "SlackChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SlackChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Slack channel." + }, + "channelName": { + "type": "string", + "enum": [ + "SlackChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Slack channel definition" + }, + "SlackChannelProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The Slack client id" + }, + "clientSecret": { + "type": "string", + "description": "The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "verificationToken": { + "type": "string", + "description": "The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "landingPageUrl": { + "type": "string", + "description": "The Slack landing page Url" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "clientId", + "clientSecret", + "verificationToken", + "isEnabled" + ], + "description": "The parameters to provide for the Slack channel." + }, + "SmsChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SmsChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Sms channel." + }, + "channelName": { + "type": "string", + "enum": [ + "SmsChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Sms channel definition" + }, + "SmsChannelProperties": { + "type": "object", + "properties": { + "phone": { + "type": "string", + "description": "The Sms phone" + }, + "accountSID": { + "type": "string", + "description": "The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "authToken": { + "type": "string", + "description": "The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "phone", + "accountSID", + "authToken", + "isEnabled" + ], + "description": "The parameters to provide for the Sms channel." + }, + "TelegramChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TelegramChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Telegram channel." + }, + "channelName": { + "type": "string", + "enum": [ + "TelegramChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Telegram channel definition" + }, + "TelegramChannelProperties": { + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "description": "The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this channel is enabled for the bot" + } + }, + "required": [ + "accessToken", + "isEnabled" + ], + "description": "The parameters to provide for the Telegram channel." + }, + "WebChatChannel": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/WebChatChannelProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the Web Chat channel." + }, + "channelName": { + "type": "string", + "enum": [ + "WebChatChannel" + ] + } + }, + "required": [ + "channelName" + ], + "description": "Web Chat channel definition" + }, + "WebChatChannelProperties": { + "type": "object", + "properties": { + "sites": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/WebChatSite" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Web Chat sites" + } + }, + "description": "The parameters to provide for the Web Chat channel." + }, + "WebChatSite": { + "type": "object", + "properties": { + "siteName": { + "type": "string", + "description": "Site name" + }, + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for DirectLine channel" + }, + "enablePreview": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this site is enabled for preview versions of Webchat" + } + }, + "required": [ + "siteName", + "isEnabled", + "enablePreview" + ], + "description": "A site for the Webchat channel" + } + } +} diff --git a/test/Resource/Expected/Microsoft.DataBox/2018-01-01/Microsoft.DataBox.json b/test/Resource/Expected/Microsoft.DataBox/2018-01-01/Microsoft.DataBox.json new file mode 100644 index 0000000..570c4b6 --- /dev/null +++ b/test/Resource/Expected/Microsoft.DataBox/2018-01-01/Microsoft.DataBox.json @@ -0,0 +1,523 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-01-01/Microsoft.DataBox.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.DataBox", + "description": "Microsoft DataBox Resource Types", + "resourceDefinitions": { + "jobs": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[-\\w\\.]+$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBox/jobs" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups)." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Sku." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/JobProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Job Properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "sku", + "properties" + ], + "description": "Microsoft.DataBox/jobs" + } + }, + "definitions": { + "ContactDetails": { + "type": "object", + "properties": { + "contactName": { + "type": "string", + "description": "Contact name of the person." + }, + "phone": { + "type": "string", + "description": "Phone number of the contact person." + }, + "phoneExtension": { + "type": "string", + "description": "Phone extension number of the contact person." + }, + "mobile": { + "type": "string", + "description": "Mobile number of the contact person." + }, + "emailList": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Email-ids to be notified about job progress." + }, + "notificationPreference": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NotificationPreference" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Notification preference for a job stage." + } + }, + "required": [ + "contactName", + "phone", + "emailList" + ], + "description": "Contact Details." + }, + "DataBoxDiskJobDetails": { + "type": "object", + "properties": { + "preferredDisks": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "integer" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "passkey": { + "type": "string", + "description": "User entered passkey for DataBox Disk job." + }, + "jobDetailsType": { + "type": "string", + "enum": [ + "DataBoxDisk" + ] + } + }, + "required": [ + "jobDetailsType" + ], + "description": "DataBox Disk Job Details." + }, + "DataBoxHeavyJobDetails": { + "type": "object", + "properties": { + "jobDetailsType": { + "type": "string", + "enum": [ + "DataBoxHeavy" + ] + } + }, + "required": [ + "jobDetailsType" + ], + "description": "DataBoxHeavy Device Job Details" + }, + "DataBoxJobDetails": { + "type": "object", + "properties": { + "jobDetailsType": { + "type": "string", + "enum": [ + "DataBox" + ] + } + }, + "required": [ + "jobDetailsType" + ], + "description": "DataBox Job Details" + }, + "DestinationAccountDetails": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/DestinationManagedDiskDetails" + }, + { + "$ref": "#/definitions/DestinationStorageAccountDetails" + } + ], + "properties": { + "accountId": { + "type": "string", + "description": "Arm Id of the destination where the data has to be moved." + } + }, + "description": "Details of the destination of the data" + }, + "DestinationManagedDiskDetails": { + "type": "object", + "properties": { + "resourceGroupId": { + "type": "string", + "description": "Destination Resource Group Id where the Compute disks should be created." + }, + "stagingStorageAccountId": { + "type": "string", + "description": "Arm Id of the storage account that can be used to copy the vhd for staging." + }, + "dataDestinationType": { + "type": "string", + "enum": [ + "ManagedDisk" + ] + } + }, + "required": [ + "resourceGroupId", + "stagingStorageAccountId", + "dataDestinationType" + ], + "description": "Details for the destination compute disks." + }, + "DestinationStorageAccountDetails": { + "type": "object", + "properties": { + "storageAccountId": { + "type": "string", + "description": "Destination Storage Account Arm Id." + }, + "dataDestinationType": { + "type": "string", + "enum": [ + "StorageAccount" + ] + } + }, + "required": [ + "storageAccountId", + "dataDestinationType" + ], + "description": "Details for the destination storage account." + }, + "JobDetails": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/DataBoxDiskJobDetails" + }, + { + "$ref": "#/definitions/DataBoxHeavyJobDetails" + }, + { + "$ref": "#/definitions/DataBoxJobDetails" + } + ], + "properties": { + "expectedDataSizeInTeraBytes": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The expected size of the data, which needs to be transferred in this job, in terabytes." + }, + "contactDetails": { + "oneOf": [ + { + "$ref": "#/definitions/ContactDetails" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contact Details." + }, + "shippingAddress": { + "oneOf": [ + { + "$ref": "#/definitions/ShippingAddress" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Shipping address where customer wishes to receive the device." + }, + "destinationAccountDetails": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DestinationAccountDetails" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Destination account details." + }, + "preferences": { + "oneOf": [ + { + "$ref": "#/definitions/Preferences" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Preferences related to the order" + } + }, + "required": [ + "contactDetails", + "shippingAddress", + "destinationAccountDetails" + ], + "description": "Job details." + }, + "JobProperties": { + "type": "object", + "properties": { + "details": { + "oneOf": [ + { + "$ref": "#/definitions/JobDetails" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Job details." + } + }, + "description": "Job Properties" + }, + "NotificationPreference": { + "type": "object", + "properties": { + "stageName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Name of the stage." + }, + "sendNotification": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Notification is required or not." + } + }, + "required": [ + "stageName", + "sendNotification" + ], + "description": "Notification preference for a job stage." + }, + "Preferences": { + "type": "object", + "properties": { + "preferredDataCenterRegion": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "description": "Preferences related to the order" + }, + "ShippingAddress": { + "type": "object", + "properties": { + "streetAddress1": { + "type": "string", + "description": "Street Address line 1." + }, + "streetAddress2": { + "type": "string", + "description": "Street Address line 2." + }, + "streetAddress3": { + "type": "string", + "description": "Street Address line 3." + }, + "city": { + "type": "string", + "description": "Name of the City." + }, + "stateOrProvince": { + "type": "string", + "description": "Name of the State or Province." + }, + "country": { + "type": "string", + "description": "Name of the Country." + }, + "postalCode": { + "type": "string", + "description": "Postal code." + }, + "zipExtendedCode": { + "type": "string", + "description": "Extended Zip Code." + }, + "companyName": { + "type": "string", + "description": "Name of the company." + }, + "addressType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "Residential", + "Commercial" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of address." + } + }, + "required": [ + "streetAddress1", + "country", + "postalCode" + ], + "description": "Shipping address where customer wishes to receive the device." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + }, + "displayName": { + "type": "string", + "description": "The display name of the sku." + }, + "family": { + "type": "string", + "description": "The sku family." + } + }, + "required": [ + "name" + ], + "description": "The Sku." + } + } +} diff --git a/test/Resource/Expected/Microsoft.DataBoxEdge/2019-03-01/Microsoft.DataBoxEdge.json b/test/Resource/Expected/Microsoft.DataBoxEdge/2019-03-01/Microsoft.DataBoxEdge.json new file mode 100644 index 0000000..6affc43 --- /dev/null +++ b/test/Resource/Expected/Microsoft.DataBoxEdge/2019-03-01/Microsoft.DataBoxEdge.json @@ -0,0 +1,1699 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.DataBoxEdge.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.DataBoxEdge", + "description": "Microsoft DataBoxEdge Resource Types", + "resourceDefinitions": { + "dataBoxEdgeDevices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The device name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of tags that describe the device. These tags can be used to view and group this device (across resource groups)." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU type." + }, + "etag": { + "type": "string", + "description": "The etag for the devices." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DataBoxEdgeDeviceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the Data Box Edge/Gateway device." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/dataBoxEdgeDevices_bandwidthSchedules_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_orders_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_roles_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_shares_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_storageAccountCredentials_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_triggers_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_users_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + "dataBoxEdgeDevices_bandwidthSchedules": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/BandwidthScheduleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the bandwidth schedule." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules" + }, + "dataBoxEdgeDevices_orders": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OrderProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Order properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders" + }, + "dataBoxEdgeDevices_roles": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/IoTRole" + } + ], + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles" + }, + "dataBoxEdgeDevices_shares": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ShareProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The share properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares" + }, + "dataBoxEdgeDevices_storageAccountCredentials": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/StorageAccountCredentialProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The storage account credential properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + }, + "dataBoxEdgeDevices_triggers": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/FileEventTrigger" + }, + { + "$ref": "#/definitions/PeriodicTimerEventTrigger" + } + ], + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers" + }, + "dataBoxEdgeDevices_users": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/UserProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The user properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + }, + "definitions": { + "Address": { + "type": "object", + "properties": { + "addressLine1": { + "type": "string", + "description": "The address line1." + }, + "addressLine2": { + "type": "string", + "description": "The address line2." + }, + "addressLine3": { + "type": "string", + "description": "The address line3." + }, + "postalCode": { + "type": "string", + "description": "The postal code." + }, + "city": { + "type": "string", + "description": "The city name." + }, + "state": { + "type": "string", + "description": "The state name." + }, + "country": { + "type": "string", + "description": "The country name." + } + }, + "required": [ + "addressLine1", + "postalCode", + "city", + "state", + "country" + ], + "description": "The shipping address of the customer." + }, + "AsymmetricEncryptedSecret": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The value of the secret." + }, + "encryptionCertThumbprint": { + "type": "string", + "description": "Thumbprint certificate used to encrypt \\\"Value\\\". If the value is unencrypted, it will be null." + }, + "encryptionAlgorithm": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "AES256", + "RSAES_PKCS1_v_1_5" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The algorithm used to encrypt \"Value\"." + } + }, + "required": [ + "value", + "encryptionAlgorithm" + ], + "description": "Represent the secrets intended for encryption with asymmetric key pair." + }, + "Authentication": { + "type": "object", + "properties": { + "symmetricKey": { + "oneOf": [ + { + "$ref": "#/definitions/SymmetricKey" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Symmetric key for authentication." + } + }, + "description": "Authentication mechanism for IoT devices." + }, + "AzureContainerInfo": { + "type": "object", + "properties": { + "storageAccountCredentialId": { + "type": "string", + "description": "ID of the storage account credential used to access storage." + }, + "containerName": { + "type": "string", + "description": "Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob)." + }, + "dataFormat": { + "oneOf": [ + { + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AzureFile" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Storage format used for the file represented by the share." + } + }, + "required": [ + "storageAccountCredentialId", + "containerName", + "dataFormat" + ], + "description": "Azure container mapping of the endpoint." + }, + "BandwidthScheduleProperties": { + "type": "object", + "properties": { + "start": { + "type": "string", + "description": "The start time of the schedule in UTC." + }, + "stop": { + "type": "string", + "description": "The stop time of the schedule in UTC." + }, + "rateInMbps": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The bandwidth rate in Mbps." + }, + "days": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The days of the week when this schedule is applicable." + } + }, + "required": [ + "start", + "stop", + "rateInMbps", + "days" + ], + "description": "The properties of the bandwidth schedule." + }, + "ClientAccessRight": { + "type": "object", + "properties": { + "client": { + "type": "string", + "description": "IP of the client." + }, + "accessPermission": { + "oneOf": [ + { + "type": "string", + "enum": [ + "NoAccess", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of access to be allowed for the client." + } + }, + "required": [ + "client", + "accessPermission" + ], + "description": "The mapping between a particular client IP and the type of access client has on the NFS share." + }, + "ContactDetails": { + "type": "object", + "properties": { + "contactPerson": { + "type": "string", + "description": "The contact person name." + }, + "companyName": { + "type": "string", + "description": "The name of the company." + }, + "phone": { + "type": "string", + "description": "The phone number." + }, + "emailList": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The email list." + } + }, + "required": [ + "contactPerson", + "companyName", + "phone", + "emailList" + ], + "description": "Contains all the contact details of the customer." + }, + "DataBoxEdgeDeviceProperties": { + "type": "object", + "properties": { + "dataBoxEdgeDeviceStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "ReadyToSetup", + "Online", + "Offline", + "NeedsAttention", + "Disconnected", + "PartiallyDisconnected" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The status of the Data Box Edge/Gateway device." + }, + "description": { + "type": "string", + "description": "The Description of the Data Box Edge/Gateway device." + }, + "modelDescription": { + "type": "string", + "description": "The description of the Data Box Edge/Gateway device model." + }, + "friendlyName": { + "type": "string", + "description": "The Data Box Edge/Gateway device name." + } + }, + "description": "The properties of the Data Box Edge/Gateway device." + }, + "dataBoxEdgeDevices_bandwidthSchedules_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "bandwidthSchedules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/BandwidthScheduleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the bandwidth schedule." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules" + }, + "dataBoxEdgeDevices_orders_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "orders" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OrderProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Order properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders" + }, + "dataBoxEdgeDevices_roles_childResource": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/IoTRole" + } + ], + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "roles" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles" + }, + "dataBoxEdgeDevices_shares_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "shares" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ShareProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The share properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares" + }, + "dataBoxEdgeDevices_storageAccountCredentials_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "storageAccountCredentials" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/StorageAccountCredentialProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The storage account credential properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + }, + "dataBoxEdgeDevices_triggers_childResource": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/FileEventTrigger" + }, + { + "$ref": "#/definitions/PeriodicTimerEventTrigger" + } + ], + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "triggers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers" + }, + "dataBoxEdgeDevices_users_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "users" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/UserProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The user properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + "FileEventTrigger": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/FileTriggerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "File trigger properties." + }, + "kind": { + "type": "string", + "enum": [ + "FileEvent" + ] + } + }, + "required": [ + "properties", + "kind" + ], + "description": "Trigger details." + }, + "FileSourceInfo": { + "type": "object", + "properties": { + "shareId": { + "type": "string", + "description": "File share ID." + } + }, + "required": [ + "shareId" + ], + "description": "File source details." + }, + "FileTriggerProperties": { + "type": "object", + "properties": { + "sourceInfo": { + "oneOf": [ + { + "$ref": "#/definitions/FileSourceInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "File source details." + }, + "sinkInfo": { + "oneOf": [ + { + "$ref": "#/definitions/RoleSinkInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Compute role against which events will be raised." + }, + "customContextTag": { + "type": "string", + "description": "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." + } + }, + "required": [ + "sourceInfo", + "sinkInfo" + ], + "description": "File trigger properties." + }, + "IoTDeviceInfo": { + "type": "object", + "properties": { + "deviceId": { + "type": "string", + "description": "ID of the IoT device/edge device." + }, + "ioTHostHub": { + "type": "string", + "description": "Host name for the IoT hub associated to the device." + }, + "authentication": { + "oneOf": [ + { + "$ref": "#/definitions/Authentication" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Authentication mechanism for IoT devices." + } + }, + "required": [ + "deviceId", + "ioTHostHub" + ], + "description": "Metadata of IoT device/IoT Edge device to be configured." + }, + "IoTRole": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IoTRoleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "IoT role properties." + }, + "kind": { + "type": "string", + "enum": [ + "IOT" + ] + } + }, + "required": [ + "kind" + ], + "description": "Compute role." + }, + "IoTRoleProperties": { + "type": "object", + "properties": { + "hostPlatform": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Host OS supported by the IoT role." + }, + "ioTDeviceDetails": { + "oneOf": [ + { + "$ref": "#/definitions/IoTDeviceInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Metadata of IoT device/IoT Edge device to be configured." + }, + "ioTEdgeDeviceDetails": { + "oneOf": [ + { + "$ref": "#/definitions/IoTDeviceInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Metadata of IoT device/IoT Edge device to be configured." + }, + "shareMappings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Mount points of shares in role(s)." + }, + "roleStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Role status." + } + }, + "required": [ + "hostPlatform", + "ioTDeviceDetails", + "ioTEdgeDeviceDetails", + "roleStatus" + ], + "description": "IoT role properties." + }, + "MountPointMap": { + "type": "object", + "properties": { + "shareId": { + "type": "string", + "description": "ID of the share mounted to the role VM." + } + }, + "required": [ + "shareId" + ], + "description": "The share mount point." + }, + "OrderProperties": { + "type": "object", + "properties": { + "contactInformation": { + "oneOf": [ + { + "$ref": "#/definitions/ContactDetails" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains all the contact details of the customer." + }, + "shippingAddress": { + "oneOf": [ + { + "$ref": "#/definitions/Address" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The shipping address of the customer." + }, + "currentStatus": { + "oneOf": [ + { + "$ref": "#/definitions/OrderStatus" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents a single status change." + } + }, + "required": [ + "contactInformation", + "shippingAddress" + ], + "description": "Order properties." + }, + "OrderStatus": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Untracked", + "AwaitingFulfilment", + "AwaitingPreparation", + "AwaitingShipment", + "Shipped", + "Arriving", + "Delivered", + "ReplacementRequested", + "LostDevice", + "Declined", + "ReturnInitiated", + "AwaitingReturnShipment", + "ShippedBack", + "CollectedAtMicrosoft" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Status of the order as per the allowed status types." + }, + "comments": { + "type": "string", + "description": "Comments related to this status change." + } + }, + "required": [ + "status" + ], + "description": "Represents a single status change." + }, + "PeriodicTimerEventTrigger": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PeriodicTimerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Periodic timer trigger properties." + }, + "kind": { + "type": "string", + "enum": [ + "PeriodicTimerEvent" + ] + } + }, + "required": [ + "properties", + "kind" + ], + "description": "Trigger details." + }, + "PeriodicTimerProperties": { + "type": "object", + "properties": { + "sourceInfo": { + "oneOf": [ + { + "$ref": "#/definitions/PeriodicTimerSourceInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Periodic timer event source." + }, + "sinkInfo": { + "oneOf": [ + { + "$ref": "#/definitions/RoleSinkInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Compute role against which events will be raised." + }, + "customContextTag": { + "type": "string", + "description": "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." + } + }, + "required": [ + "sourceInfo", + "sinkInfo" + ], + "description": "Periodic timer trigger properties." + }, + "PeriodicTimerSourceInfo": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "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." + }, + "schedule": { + "type": "string", + "description": "Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds." + }, + "topic": { + "type": "string", + "description": "Topic where periodic events are published to IoT device." + } + }, + "required": [ + "startTime", + "schedule" + ], + "description": "Periodic timer event source." + }, + "RefreshDetails": { + "type": "object", + "properties": { + "inProgressRefreshJobId": { + "type": "string", + "description": "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": { + "type": "string", + "format": "date-time", + "description": "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." + }, + "errorManifestFile": { + "type": "string", + "description": "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." + }, + "lastJob": { + "type": "string", + "description": "Indicates the id of the last refresh job on this particular share,if any. This could be a failed job or a successful job." + } + }, + "description": "Fields for tracking refresh job on the share." + }, + "RoleSinkInfo": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "description": "Compute role ID." + } + }, + "required": [ + "roleId" + ], + "description": "Compute role against which events will be raised." + }, + "ShareAccessRight": { + "type": "object", + "properties": { + "shareId": { + "type": "string", + "description": "The share ID." + }, + "accessType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Change", + "Read", + "Custom" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of access to be allowed on the share for this user." + } + }, + "required": [ + "shareId", + "accessType" + ], + "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device." + }, + "ShareProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description for the share." + }, + "shareStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Online", + "Offline" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Current status of the share." + }, + "monitoringStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Current monitoring status of the share." + }, + "azureContainerInfo": { + "oneOf": [ + { + "$ref": "#/definitions/AzureContainerInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure container mapping of the endpoint." + }, + "accessProtocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SMB", + "NFS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Access protocol to be used by the share." + }, + "userAccessRights": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccessRight" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Mapping of users and corresponding access rights on the share (required for SMB protocol)." + }, + "clientAccessRights": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClientAccessRight" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of IP addresses and corresponding access rights on the share(required for NFS protocol)." + }, + "refreshDetails": { + "oneOf": [ + { + "$ref": "#/definitions/RefreshDetails" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fields for tracking refresh job on the share." + }, + "dataPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Cloud", + "Local" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data policy of the share." + } + }, + "required": [ + "shareStatus", + "monitoringStatus", + "accessProtocol" + ], + "description": "The share properties." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Gateway", + "Edge" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SKU name." + }, + "tier": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU tier. This is based on the SKU name." + } + }, + "description": "The SKU type." + }, + "StorageAccountCredentialProperties": { + "type": "object", + "properties": { + "alias": { + "type": "string", + "description": "Alias for the storage account." + }, + "userName": { + "type": "string", + "description": "Username for the storage account." + }, + "accountKey": { + "oneOf": [ + { + "$ref": "#/definitions/AsymmetricEncryptedSecret" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represent the secrets intended for encryption with asymmetric key pair." + }, + "connectionString": { + "type": "string", + "description": "Connection string for the storage account. Use this string if username and account key are not specified." + }, + "sslStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Signifies whether SSL needs to be enabled or not." + }, + "blobDomainName": { + "type": "string", + "description": "Blob end point for private clouds." + }, + "accountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "GeneralPurposeStorage", + "BlobStorage" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of storage accessed on the storage account." + } + }, + "required": [ + "alias", + "sslStatus", + "accountType" + ], + "description": "The storage account credential properties." + }, + "SymmetricKey": { + "type": "object", + "properties": { + "connectionString": { + "oneOf": [ + { + "$ref": "#/definitions/AsymmetricEncryptedSecret" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represent the secrets intended for encryption with asymmetric key pair." + } + }, + "description": "Symmetric key for authentication." + }, + "UserAccessRight": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID (already existing in the device)." + }, + "accessType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Change", + "Read", + "Custom" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of access to be allowed for the user." + } + }, + "required": [ + "userId", + "accessType" + ], + "description": "The mapping between a particular user and the access type on the SMB share." + }, + "UserProperties": { + "type": "object", + "properties": { + "encryptedPassword": { + "oneOf": [ + { + "$ref": "#/definitions/AsymmetricEncryptedSecret" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represent the secrets intended for encryption with asymmetric key pair." + }, + "shareAccessRights": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ShareAccessRight" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of shares that the user has rights on. This field should not be specified during user creation." + } + }, + "description": "The user properties." + } + } +} diff --git a/test/Resource/Expected/Microsoft.DataBoxEdge/2019-07-01/Microsoft.DataBoxEdge.json b/test/Resource/Expected/Microsoft.DataBoxEdge/2019-07-01/Microsoft.DataBoxEdge.json new file mode 100644 index 0000000..ed5d214 --- /dev/null +++ b/test/Resource/Expected/Microsoft.DataBoxEdge/2019-07-01/Microsoft.DataBoxEdge.json @@ -0,0 +1,1711 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.DataBoxEdge.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.DataBoxEdge", + "description": "Microsoft DataBoxEdge Resource Types", + "resourceDefinitions": { + "dataBoxEdgeDevices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The device name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of tags that describe the device. These tags can be used to view and group this device (across resource groups)." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU type." + }, + "etag": { + "type": "string", + "description": "The etag for the devices." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DataBoxEdgeDeviceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the Data Box Edge/Gateway device." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/dataBoxEdgeDevices_bandwidthSchedules_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_orders_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_roles_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_shares_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_storageAccountCredentials_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_triggers_childResource" + }, + { + "$ref": "#/definitions/dataBoxEdgeDevices_users_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + "dataBoxEdgeDevices_bandwidthSchedules": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/BandwidthScheduleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the bandwidth schedule." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules" + }, + "dataBoxEdgeDevices_orders": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OrderProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Order properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders" + }, + "dataBoxEdgeDevices_roles": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/IoTRole" + } + ], + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles" + }, + "dataBoxEdgeDevices_shares": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ShareProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The share properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares" + }, + "dataBoxEdgeDevices_storageAccountCredentials": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/StorageAccountCredentialProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The storage account credential properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + }, + "dataBoxEdgeDevices_triggers": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/FileEventTrigger" + }, + { + "$ref": "#/definitions/PeriodicTimerEventTrigger" + } + ], + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers" + }, + "dataBoxEdgeDevices_users": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/UserProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The user properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + }, + "definitions": { + "Address": { + "type": "object", + "properties": { + "addressLine1": { + "type": "string", + "description": "The address line1." + }, + "addressLine2": { + "type": "string", + "description": "The address line2." + }, + "addressLine3": { + "type": "string", + "description": "The address line3." + }, + "postalCode": { + "type": "string", + "description": "The postal code." + }, + "city": { + "type": "string", + "description": "The city name." + }, + "state": { + "type": "string", + "description": "The state name." + }, + "country": { + "type": "string", + "description": "The country name." + } + }, + "required": [ + "addressLine1", + "postalCode", + "city", + "state", + "country" + ], + "description": "The shipping address of the customer." + }, + "AsymmetricEncryptedSecret": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The value of the secret." + }, + "encryptionCertThumbprint": { + "type": "string", + "description": "Thumbprint certificate used to encrypt \\\"Value\\\". If the value is unencrypted, it will be null." + }, + "encryptionAlgorithm": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "AES256", + "RSAES_PKCS1_v_1_5" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The algorithm used to encrypt \"Value\"." + } + }, + "required": [ + "value", + "encryptionAlgorithm" + ], + "description": "Represent the secrets intended for encryption with asymmetric key pair." + }, + "Authentication": { + "type": "object", + "properties": { + "symmetricKey": { + "oneOf": [ + { + "$ref": "#/definitions/SymmetricKey" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Symmetric key for authentication." + } + }, + "description": "Authentication mechanism for IoT devices." + }, + "AzureContainerInfo": { + "type": "object", + "properties": { + "storageAccountCredentialId": { + "type": "string", + "description": "ID of the storage account credential used to access storage." + }, + "containerName": { + "type": "string", + "description": "Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob)." + }, + "dataFormat": { + "oneOf": [ + { + "type": "string", + "enum": [ + "BlockBlob", + "PageBlob", + "AzureFile" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Storage format used for the file represented by the share." + } + }, + "required": [ + "storageAccountCredentialId", + "containerName", + "dataFormat" + ], + "description": "Azure container mapping of the endpoint." + }, + "BandwidthScheduleProperties": { + "type": "object", + "properties": { + "start": { + "type": "string", + "description": "The start time of the schedule in UTC." + }, + "stop": { + "type": "string", + "description": "The stop time of the schedule in UTC." + }, + "rateInMbps": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The bandwidth rate in Mbps." + }, + "days": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The days of the week when this schedule is applicable." + } + }, + "required": [ + "start", + "stop", + "rateInMbps", + "days" + ], + "description": "The properties of the bandwidth schedule." + }, + "ClientAccessRight": { + "type": "object", + "properties": { + "client": { + "type": "string", + "description": "IP of the client." + }, + "accessPermission": { + "oneOf": [ + { + "type": "string", + "enum": [ + "NoAccess", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of access to be allowed for the client." + } + }, + "required": [ + "client", + "accessPermission" + ], + "description": "The mapping between a particular client IP and the type of access client has on the NFS share." + }, + "ContactDetails": { + "type": "object", + "properties": { + "contactPerson": { + "type": "string", + "description": "The contact person name." + }, + "companyName": { + "type": "string", + "description": "The name of the company." + }, + "phone": { + "type": "string", + "description": "The phone number." + }, + "emailList": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The email list." + } + }, + "required": [ + "contactPerson", + "companyName", + "phone", + "emailList" + ], + "description": "Contains all the contact details of the customer." + }, + "DataBoxEdgeDeviceProperties": { + "type": "object", + "properties": { + "dataBoxEdgeDeviceStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "ReadyToSetup", + "Online", + "Offline", + "NeedsAttention", + "Disconnected", + "PartiallyDisconnected", + "Maintenance" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The status of the Data Box Edge/Gateway device." + }, + "description": { + "type": "string", + "description": "The Description of the Data Box Edge/Gateway device." + }, + "modelDescription": { + "type": "string", + "description": "The description of the Data Box Edge/Gateway device model." + }, + "friendlyName": { + "type": "string", + "description": "The Data Box Edge/Gateway device name." + } + }, + "description": "The properties of the Data Box Edge/Gateway device." + }, + "dataBoxEdgeDevices_bandwidthSchedules_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "bandwidthSchedules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/BandwidthScheduleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the bandwidth schedule." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules" + }, + "dataBoxEdgeDevices_orders_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "orders" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OrderProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Order properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders" + }, + "dataBoxEdgeDevices_roles_childResource": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/IoTRole" + } + ], + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "roles" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles" + }, + "dataBoxEdgeDevices_shares_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "shares" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ShareProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The share properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares" + }, + "dataBoxEdgeDevices_storageAccountCredentials_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "storageAccountCredentials" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/StorageAccountCredentialProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The storage account credential properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + }, + "dataBoxEdgeDevices_triggers_childResource": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/FileEventTrigger" + }, + { + "$ref": "#/definitions/PeriodicTimerEventTrigger" + } + ], + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "triggers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers" + }, + "dataBoxEdgeDevices_users_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The alert name." + }, + "type": { + "type": "string", + "enum": [ + "users" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/UserProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The user properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + "FileEventTrigger": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/FileTriggerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "File trigger properties." + }, + "kind": { + "type": "string", + "enum": [ + "FileEvent" + ] + } + }, + "required": [ + "properties", + "kind" + ], + "description": "Trigger details." + }, + "FileSourceInfo": { + "type": "object", + "properties": { + "shareId": { + "type": "string", + "description": "File share ID." + } + }, + "required": [ + "shareId" + ], + "description": "File source details." + }, + "FileTriggerProperties": { + "type": "object", + "properties": { + "sourceInfo": { + "oneOf": [ + { + "$ref": "#/definitions/FileSourceInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "File source details." + }, + "sinkInfo": { + "oneOf": [ + { + "$ref": "#/definitions/RoleSinkInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Compute role against which events will be raised." + }, + "customContextTag": { + "type": "string", + "description": "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." + } + }, + "required": [ + "sourceInfo", + "sinkInfo" + ], + "description": "File trigger properties." + }, + "IoTDeviceInfo": { + "type": "object", + "properties": { + "deviceId": { + "type": "string", + "description": "ID of the IoT device/edge device." + }, + "ioTHostHub": { + "type": "string", + "description": "Host name for the IoT hub associated to the device." + }, + "ioTHostHubId": { + "type": "string", + "description": "Id of the IoT hub associated to the device." + }, + "authentication": { + "oneOf": [ + { + "$ref": "#/definitions/Authentication" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Authentication mechanism for IoT devices." + } + }, + "required": [ + "deviceId", + "ioTHostHub" + ], + "description": "Metadata of IoT device/IoT Edge device to be configured." + }, + "IoTRole": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IoTRoleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "IoT role properties." + }, + "kind": { + "type": "string", + "enum": [ + "IOT" + ] + } + }, + "required": [ + "kind" + ], + "description": "Compute role." + }, + "IoTRoleProperties": { + "type": "object", + "properties": { + "hostPlatform": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Host OS supported by the IoT role." + }, + "ioTDeviceDetails": { + "oneOf": [ + { + "$ref": "#/definitions/IoTDeviceInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Metadata of IoT device/IoT Edge device to be configured." + }, + "ioTEdgeDeviceDetails": { + "oneOf": [ + { + "$ref": "#/definitions/IoTDeviceInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Metadata of IoT device/IoT Edge device to be configured." + }, + "shareMappings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Mount points of shares in role(s)." + }, + "roleStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Role status." + } + }, + "required": [ + "hostPlatform", + "ioTDeviceDetails", + "ioTEdgeDeviceDetails", + "roleStatus" + ], + "description": "IoT role properties." + }, + "MountPointMap": { + "type": "object", + "properties": { + "shareId": { + "type": "string", + "description": "ID of the share mounted to the role VM." + } + }, + "required": [ + "shareId" + ], + "description": "The share mount point." + }, + "OrderProperties": { + "type": "object", + "properties": { + "contactInformation": { + "oneOf": [ + { + "$ref": "#/definitions/ContactDetails" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains all the contact details of the customer." + }, + "shippingAddress": { + "oneOf": [ + { + "$ref": "#/definitions/Address" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The shipping address of the customer." + }, + "currentStatus": { + "oneOf": [ + { + "$ref": "#/definitions/OrderStatus" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents a single status change." + } + }, + "required": [ + "contactInformation", + "shippingAddress" + ], + "description": "Order properties." + }, + "OrderStatus": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Untracked", + "AwaitingFulfilment", + "AwaitingPreparation", + "AwaitingShipment", + "Shipped", + "Arriving", + "Delivered", + "ReplacementRequested", + "LostDevice", + "Declined", + "ReturnInitiated", + "AwaitingReturnShipment", + "ShippedBack", + "CollectedAtMicrosoft" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Status of the order as per the allowed status types." + }, + "comments": { + "type": "string", + "description": "Comments related to this status change." + } + }, + "required": [ + "status" + ], + "description": "Represents a single status change." + }, + "PeriodicTimerEventTrigger": { + "type": "object", + "properties": { + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/PeriodicTimerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Periodic timer trigger properties." + }, + "kind": { + "type": "string", + "enum": [ + "PeriodicTimerEvent" + ] + } + }, + "required": [ + "properties", + "kind" + ], + "description": "Trigger details." + }, + "PeriodicTimerProperties": { + "type": "object", + "properties": { + "sourceInfo": { + "oneOf": [ + { + "$ref": "#/definitions/PeriodicTimerSourceInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Periodic timer event source." + }, + "sinkInfo": { + "oneOf": [ + { + "$ref": "#/definitions/RoleSinkInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Compute role against which events will be raised." + }, + "customContextTag": { + "type": "string", + "description": "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." + } + }, + "required": [ + "sourceInfo", + "sinkInfo" + ], + "description": "Periodic timer trigger properties." + }, + "PeriodicTimerSourceInfo": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "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." + }, + "schedule": { + "type": "string", + "description": "Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds." + }, + "topic": { + "type": "string", + "description": "Topic where periodic events are published to IoT device." + } + }, + "required": [ + "startTime", + "schedule" + ], + "description": "Periodic timer event source." + }, + "RefreshDetails": { + "type": "object", + "properties": { + "inProgressRefreshJobId": { + "type": "string", + "description": "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": { + "type": "string", + "format": "date-time", + "description": "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." + }, + "errorManifestFile": { + "type": "string", + "description": "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." + }, + "lastJob": { + "type": "string", + "description": "Indicates the id of the last refresh job on this particular share,if any. This could be a failed job or a successful job." + } + }, + "description": "Fields for tracking refresh job on the share." + }, + "RoleSinkInfo": { + "type": "object", + "properties": { + "roleId": { + "type": "string", + "description": "Compute role ID." + } + }, + "required": [ + "roleId" + ], + "description": "Compute role against which events will be raised." + }, + "ShareAccessRight": { + "type": "object", + "properties": { + "shareId": { + "type": "string", + "description": "The share ID." + }, + "accessType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Change", + "Read", + "Custom" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of access to be allowed on the share for this user." + } + }, + "required": [ + "shareId", + "accessType" + ], + "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device." + }, + "ShareProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description for the share." + }, + "shareStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Offline", + "Unknown", + "OK", + "Updating", + "NeedsAttention" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Current status of the share." + }, + "monitoringStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Current monitoring status of the share." + }, + "azureContainerInfo": { + "oneOf": [ + { + "$ref": "#/definitions/AzureContainerInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure container mapping of the endpoint." + }, + "accessProtocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SMB", + "NFS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Access protocol to be used by the share." + }, + "userAccessRights": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccessRight" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Mapping of users and corresponding access rights on the share (required for SMB protocol)." + }, + "clientAccessRights": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClientAccessRight" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of IP addresses and corresponding access rights on the share(required for NFS protocol)." + }, + "refreshDetails": { + "oneOf": [ + { + "$ref": "#/definitions/RefreshDetails" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fields for tracking refresh job on the share." + }, + "dataPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Cloud", + "Local" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data policy of the share." + } + }, + "required": [ + "shareStatus", + "monitoringStatus", + "accessProtocol" + ], + "description": "The share properties." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Gateway", + "Edge" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SKU name." + }, + "tier": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU tier. This is based on the SKU name." + } + }, + "description": "The SKU type." + }, + "StorageAccountCredentialProperties": { + "type": "object", + "properties": { + "alias": { + "type": "string", + "description": "Alias for the storage account." + }, + "userName": { + "type": "string", + "description": "Username for the storage account." + }, + "accountKey": { + "oneOf": [ + { + "$ref": "#/definitions/AsymmetricEncryptedSecret" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represent the secrets intended for encryption with asymmetric key pair." + }, + "connectionString": { + "type": "string", + "description": "Connection string for the storage account. Use this string if username and account key are not specified." + }, + "sslStatus": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Signifies whether SSL needs to be enabled or not." + }, + "blobDomainName": { + "type": "string", + "description": "Blob end point for private clouds." + }, + "accountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "GeneralPurposeStorage", + "BlobStorage" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of storage accessed on the storage account." + }, + "storageAccountId": { + "type": "string", + "description": "Id of the storage account." + } + }, + "required": [ + "alias", + "sslStatus", + "accountType" + ], + "description": "The storage account credential properties." + }, + "SymmetricKey": { + "type": "object", + "properties": { + "connectionString": { + "oneOf": [ + { + "$ref": "#/definitions/AsymmetricEncryptedSecret" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represent the secrets intended for encryption with asymmetric key pair." + } + }, + "description": "Symmetric key for authentication." + }, + "UserAccessRight": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User ID (already existing in the device)." + }, + "accessType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Change", + "Read", + "Custom" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of access to be allowed for the user." + } + }, + "required": [ + "userId", + "accessType" + ], + "description": "The mapping between a particular user and the access type on the SMB share." + }, + "UserProperties": { + "type": "object", + "properties": { + "encryptedPassword": { + "oneOf": [ + { + "$ref": "#/definitions/AsymmetricEncryptedSecret" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represent the secrets intended for encryption with asymmetric key pair." + }, + "shareAccessRights": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ShareAccessRight" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of shares that the user has rights on. This field should not be specified during user creation." + } + }, + "description": "The user properties." + } + } +} diff --git a/test/Resource/Expected/Microsoft.Databricks/2018-04-01/Microsoft.Databricks.json b/test/Resource/Expected/Microsoft.Databricks/2018-04-01/Microsoft.Databricks.json new file mode 100644 index 0000000..fce81ec --- /dev/null +++ b/test/Resource/Expected/Microsoft.Databricks/2018-04-01/Microsoft.Databricks.json @@ -0,0 +1,169 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-04-01/Microsoft.Databricks.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Databricks", + "description": "Microsoft Databricks Resource Types", + "resourceDefinitions": { + "workspaces": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 3, + "maxLength": 64, + "description": "The name of the workspace." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Databricks/workspaces" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/WorkspaceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The workspace properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SKU for the resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.Databricks/workspaces" + } + }, + "definitions": { + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The SKU name." + }, + "tier": { + "type": "string", + "description": "The SKU tier." + } + }, + "required": [ + "name" + ], + "description": "SKU for the resource." + }, + "WorkspaceProperties": { + "type": "object", + "properties": { + "managedResourceGroupId": { + "type": "string", + "description": "The managed resource group Id." + }, + "parameters": { + "type": "object", + "properties": {}, + "description": "Name and value pairs that define the workspace parameters." + }, + "uiDefinitionUri": { + "type": "string", + "description": "The blob URI where the UI definition file is located." + }, + "authorizations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceProviderAuthorization" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The workspace provider authorizations." + } + }, + "required": [ + "managedResourceGroupId" + ], + "description": "The workspace properties." + }, + "WorkspaceProviderAuthorization": { + "type": "object", + "properties": { + "principalId": { + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources." + }, + "roleDefinitionId": { + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "required": [ + "principalId", + "roleDefinitionId" + ], + "description": "The workspace provider authorization." + } + } +} diff --git a/test/Resource/Expected/Microsoft.DevSpaces/2019-04-01/Microsoft.DevSpaces.json b/test/Resource/Expected/Microsoft.DevSpaces/2019-04-01/Microsoft.DevSpaces.json new file mode 100644 index 0000000..8dd6998 --- /dev/null +++ b/test/Resource/Expected/Microsoft.DevSpaces/2019-04-01/Microsoft.DevSpaces.json @@ -0,0 +1,141 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-04-01/Microsoft.DevSpaces.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.DevSpaces", + "description": "Microsoft DevSpaces Resource Types", + "resourceDefinitions": { + "controllers": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z0-9]([_-]*[a-zA-Z0-9])*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Name of the resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DevSpaces/controllers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-04-01" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags for the Azure resource." + }, + "location": { + "type": "string", + "description": "Region where the Azure resource is located." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ControllerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Model representing SKU for Azure Dev Spaces Controller." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties", + "sku" + ], + "description": "Microsoft.DevSpaces/controllers" + } + }, + "definitions": { + "ControllerProperties": { + "type": "object", + "properties": { + "targetContainerHostResourceId": { + "type": "string", + "description": "Resource ID of the target container host" + }, + "targetContainerHostCredentialsBase64": { + "type": "string", + "description": "Credentials of the target container host (base64)." + } + }, + "required": [ + "targetContainerHostResourceId", + "targetContainerHostCredentialsBase64" + ] + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "S1" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the SKU for Azure Dev Spaces Controller." + }, + "tier": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tier of the SKU for Azure Dev Spaces Controller." + } + }, + "required": [ + "name" + ], + "description": "Model representing SKU for Azure Dev Spaces Controller." + } + } +} diff --git a/test/Resource/Expected/Microsoft.DocumentDB/2015-04-08/Microsoft.DocumentDB.json b/test/Resource/Expected/Microsoft.DocumentDB/2015-04-08/Microsoft.DocumentDB.json new file mode 100644 index 0000000..db38332 --- /dev/null +++ b/test/Resource/Expected/Microsoft.DocumentDB/2015-04-08/Microsoft.DocumentDB.json @@ -0,0 +1,2561 @@ +{ + "id": "https://schema.management.azure.com/schemas/2015-04-08/Microsoft.DocumentDB.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.DocumentDB", + "description": "Microsoft DocumentDB Resource Types", + "resourceDefinitions": { + "databaseAccounts": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB database account name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "GlobalDocumentDB", + "MongoDB", + "Parse" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the type of database account. This can only be set at database account creation." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DatabaseAccountCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB database accounts." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts" + }, + "databaseAccounts_apis_databases": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB database name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/databases" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlDatabaseCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB SQL database." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_apis_databases_settings_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_apis_databases_containers_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_apis_databases_collections_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_apis_databases_graphs_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases" + }, + "databaseAccounts_apis_databases_collections": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB collection name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBCollectionCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB collection." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_apis_databases_collections_settings_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections" + }, + "databaseAccounts_apis_databases_collections_settings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings" + }, + "databaseAccounts_apis_databases_containers": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB container name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlContainerCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB container." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_apis_databases_containers_settings_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers" + }, + "databaseAccounts_apis_databases_containers_settings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings" + }, + "databaseAccounts_apis_databases_graphs": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB graph name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinGraphCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin graph." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_apis_databases_graphs_settings_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs" + }, + "databaseAccounts_apis_databases_graphs_settings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings" + }, + "databaseAccounts_apis_databases_settings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/databases/settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/settings" + }, + "databaseAccounts_apis_keyspaces": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB keyspace name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraKeyspaceCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_apis_keyspaces_settings_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_apis_keyspaces_tables_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces" + }, + "databaseAccounts_apis_keyspaces_settings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings" + }, + "databaseAccounts_apis_keyspaces_tables": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB table name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraTableCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra table." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_apis_keyspaces_tables_settings_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables" + }, + "databaseAccounts_apis_keyspaces_tables_settings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings" + }, + "databaseAccounts_apis_tables": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB table name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/tables" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TableCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Table." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_apis_tables_settings_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/tables" + }, + "databaseAccounts_apis_tables_settings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/apis/tables/settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/tables/settings" + } + }, + "definitions": { + "Capability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB capability. For example, \"name\": \"EnableCassandra\". Current values also include \"EnableTable\" and \"EnableGremlin\"." + } + }, + "description": "Cosmos DB capability object" + }, + "CassandraKeyspaceCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraKeyspaceResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Cassandra keyspace id object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace." + }, + "CassandraKeyspaceResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra keyspace" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB Cassandra keyspace id object" + }, + "CassandraPartitionKey": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table partition key" + } + }, + "description": "Cosmos DB Cassandra table partition key" + }, + "CassandraSchema": { + "type": "object", + "properties": { + "columns": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Column" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Cassandra table columns." + }, + "partitionKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/CassandraPartitionKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of partition key." + }, + "clusterKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of cluster key." + } + }, + "description": "Cosmos DB Cassandra table schema" + }, + "CassandraTableCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraTableResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Cassandra table id object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra table." + }, + "CassandraTableResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table" + }, + "defaultTtl": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Time to live of the Cosmos DB Cassandra table" + }, + "schema": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraSchema" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Cassandra table schema" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB Cassandra table id object" + }, + "ClusterKey": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table cluster key" + }, + "orderBy": { + "type": "string", + "description": "Order of the Cosmos DB Cassandra table cluster key, only support \"Asc\" and \"Desc\"" + } + }, + "description": "Cosmos DB Cassandra table cluster key" + }, + "Column": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table column" + }, + "type": { + "type": "string", + "description": "Type of the Cosmos DB Cassandra table column" + } + }, + "description": "Cosmos DB Cassandra table column" + }, + "ConflictResolutionPolicy": { + "type": "object", + "properties": { + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "LastWriterWins", + "Custom" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the conflict resolution mode." + }, + "conflictResolutionPath": { + "type": "string", + "description": "The conflict resolution path in the case of LastWriterWins mode." + }, + "conflictResolutionProcedure": { + "type": "string", + "description": "The procedure to resolve conflicts in the case of custom mode." + } + }, + "description": "The conflict resolution policy for the container." + }, + "ConsistencyPolicy": { + "type": "object", + "properties": { + "defaultConsistencyLevel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Eventual", + "Session", + "BoundedStaleness", + "Strong", + "ConsistentPrefix" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The default consistency level and configuration settings of the Cosmos DB account." + }, + "maxStalenessPrefix": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 2147483647 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + }, + "maxIntervalInSeconds": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 86400 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + } + }, + "required": [ + "defaultConsistencyLevel" + ], + "description": "The consistency policy for the Cosmos DB database account." + }, + "ContainerPartitionKey": { + "type": "object", + "properties": { + "paths": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of paths using which data within the container can be partitioned" + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Hash", + "Range" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the kind of algorithm used for partitioning." + } + }, + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "DatabaseAccountCreateUpdateProperties": { + "type": "object", + "properties": { + "consistencyPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ConsistencyPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The consistency policy for the Cosmos DB database account." + }, + "locations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Location" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "An array that contains the georeplication locations enabled for the Cosmos DB account." + }, + "databaseAccountOfferType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The offer type for the database" + }, + "ipRangeFilter": { + "type": "string", + "description": "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": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules." + }, + "enableAutomaticFailover": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "capabilities": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Capability" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Cosmos DB capabilities for the account" + }, + "virtualNetworkRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account." + }, + "enableMultipleWriteLocations": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables the account to write in multiple locations" + }, + "enableCassandraConnector": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables the cassandra connector on the Cosmos DB C* account" + }, + "connectorOffer": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Small" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The cassandra connector offer type for the Cosmos DB database C* account." + } + }, + "required": [ + "locations", + "databaseAccountOfferType" + ], + "description": "Properties to create and update Azure Cosmos DB database accounts." + }, + "databaseAccounts_apis_databases_collections_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB collection name." + }, + "type": { + "type": "string", + "enum": [ + "collections" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBCollectionCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB collection." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections" + }, + "databaseAccounts_apis_databases_collections_settings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings" + }, + "databaseAccounts_apis_databases_containers_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB container name." + }, + "type": { + "type": "string", + "enum": [ + "containers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlContainerCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB container." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers" + }, + "databaseAccounts_apis_databases_containers_settings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings" + }, + "databaseAccounts_apis_databases_graphs_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB graph name." + }, + "type": { + "type": "string", + "enum": [ + "graphs" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinGraphCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin graph." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs" + }, + "databaseAccounts_apis_databases_graphs_settings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings" + }, + "databaseAccounts_apis_databases_settings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/databases/settings" + }, + "databaseAccounts_apis_keyspaces_settings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings" + }, + "databaseAccounts_apis_keyspaces_tables_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB table name." + }, + "type": { + "type": "string", + "enum": [ + "tables" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraTableCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra table." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables" + }, + "databaseAccounts_apis_keyspaces_tables_settings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings" + }, + "databaseAccounts_apis_tables_settings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/throughput$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "settings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-04-08" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/apis/tables/settings" + }, + "ExcludedPath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + } + } + }, + "GremlinDatabaseCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinDatabaseResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Gremlin database id object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin database." + }, + "GremlinDatabaseResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin database" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB Gremlin database id object" + }, + "GremlinGraphCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinGraphResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Gremlin graph resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin graph." + }, + "GremlinGraphResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin graph" + }, + "indexingPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/IndexingPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB indexing policy" + }, + "partitionKey": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerPartitionKey" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UniqueKeyPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ConflictResolutionPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The conflict resolution policy for the container." + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB Gremlin graph resource object" + }, + "IncludedPath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "indexes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Indexes" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of indexes for this path" + } + }, + "description": "The paths that are included in indexing" + }, + "Indexes": { + "type": "object", + "properties": { + "dataType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "String", + "Number", + "Point", + "Polygon", + "LineString", + "MultiPolygon" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The datatype for which the indexing behavior is applied to." + }, + "precision": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The precision of the index. -1 is maximum precision." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Hash", + "Range", + "Spatial" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the type of index." + } + }, + "description": "The indexes for the path." + }, + "IndexingPolicy": { + "type": "object", + "properties": { + "automatic": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the indexing policy is automatic" + }, + "indexingMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Consistent", + "Lazy", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the indexing mode." + }, + "includedPaths": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/IncludedPath" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of paths to include in the indexing" + }, + "excludedPaths": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ExcludedPath" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of paths to exclude from indexing" + } + }, + "description": "Cosmos DB indexing policy" + }, + "Location": { + "type": "object", + "properties": { + "locationName": { + "type": "string", + "description": "The name of the region." + }, + "provisioningState": { + "type": "string", + "description": "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." + }, + "failoverPriority": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "isZoneRedundant": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Flag to indicate whether or not this region is an AvailabilityZone region" + } + }, + "description": "A region in which the Azure Cosmos DB database account is deployed." + }, + "MongoDBCollectionCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBCollectionResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB MongoDB collection resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB collection." + }, + "MongoDBCollectionResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB collection" + }, + "shardKey": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The shard key and partition kind pair, only support \"Hash\" partition kind" + }, + "indexes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/MongoIndex" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of index keys" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB MongoDB collection resource object" + }, + "MongoDBDatabaseCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBDatabaseResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB MongoDB database id object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB database." + }, + "MongoDBDatabaseResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB database" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB MongoDB database id object" + }, + "MongoIndex": { + "type": "object", + "properties": { + "key": { + "oneOf": [ + { + "$ref": "#/definitions/MongoIndexKeys" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB MongoDB collection resource object" + }, + "options": { + "oneOf": [ + { + "$ref": "#/definitions/MongoIndexOptions" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB MongoDB collection index options" + } + }, + "description": "Cosmos DB MongoDB collection index key" + }, + "MongoIndexKeys": { + "type": "object", + "properties": { + "keys": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of keys for each MongoDB collection in the Azure Cosmos DB service" + } + }, + "description": "Cosmos DB MongoDB collection resource object" + }, + "MongoIndexOptions": { + "type": "object", + "properties": { + "expireAfterSeconds": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Expire after seconds" + }, + "unique": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Is unique or not" + } + }, + "description": "Cosmos DB MongoDB collection index options" + }, + "SqlContainerCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/SqlContainerResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB SQL container resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB container." + }, + "SqlContainerResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL container" + }, + "indexingPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/IndexingPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB indexing policy" + }, + "partitionKey": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerPartitionKey" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UniqueKeyPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ConflictResolutionPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The conflict resolution policy for the container." + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB SQL container resource object" + }, + "SqlDatabaseCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/SqlDatabaseResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB SQL database id object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB SQL database." + }, + "SqlDatabaseResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL database" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB SQL database id object" + }, + "TableCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/TableResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB table id object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Table." + }, + "TableResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB table" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB table id object" + }, + "ThroughputResource": { + "type": "object", + "properties": { + "throughput": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value of the Cosmos DB resource throughput" + } + }, + "required": [ + "throughput" + ], + "description": "Cosmos DB resource throughput object" + }, + "ThroughputUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB resource throughput object" + } + }, + "required": [ + "resource" + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + }, + "UniqueKey": { + "type": "object", + "properties": { + "paths": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of paths must be unique for each document in the Azure Cosmos DB service" + } + }, + "description": "The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service." + }, + "UniqueKeyPolicy": { + "type": "object", + "properties": { + "uniqueKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/UniqueKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service." + } + }, + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "VirtualNetworkRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}." + }, + "ignoreMissingVNetServiceEndpoint": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Create firewall rule before the virtual network has vnet service endpoint enabled." + } + }, + "description": "Virtual Network ACL Rule object" + } + } +} diff --git a/test/Resource/Expected/Microsoft.DocumentDB/2019-08-01/Microsoft.DocumentDB.json b/test/Resource/Expected/Microsoft.DocumentDB/2019-08-01/Microsoft.DocumentDB.json new file mode 100644 index 0000000..ad870e9 --- /dev/null +++ b/test/Resource/Expected/Microsoft.DocumentDB/2019-08-01/Microsoft.DocumentDB.json @@ -0,0 +1,4293 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-08-01/Microsoft.DocumentDB.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.DocumentDB", + "description": "Microsoft DocumentDB Resource Types", + "resourceDefinitions": { + "databaseAccounts": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB database account name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "GlobalDocumentDB", + "MongoDB", + "Parse" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the type of database account. This can only be set at database account creation." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DatabaseAccountCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB database accounts." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_sqlDatabases_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_mongodbDatabases_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_tables_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_cassandraKeyspaces_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_gremlinDatabases_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts" + }, + "databaseAccounts_cassandraKeyspaces": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB keyspace name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraKeyspaceCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_cassandraKeyspaces_throughputSettings_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_cassandraKeyspaces_tables_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces" + }, + "databaseAccounts_cassandraKeyspaces_tables": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB table name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraTableCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra table." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_cassandraKeyspaces_tables_throughputSettings_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables" + }, + "databaseAccounts_cassandraKeyspaces_tables_throughputSettings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings" + }, + "databaseAccounts_cassandraKeyspaces_throughputSettings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings" + }, + "databaseAccounts_gremlinDatabases": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB database name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinDatabaseCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin database." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_gremlinDatabases_throughputSettings_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_gremlinDatabases_graphs_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases" + }, + "databaseAccounts_gremlinDatabases_graphs": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB graph name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinGraphCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin graph." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_gremlinDatabases_graphs_throughputSettings_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs" + }, + "databaseAccounts_gremlinDatabases_graphs_throughputSettings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings" + }, + "databaseAccounts_gremlinDatabases_throughputSettings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings" + }, + "databaseAccounts_mongodbDatabases": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB database name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBDatabaseCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB database." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_mongodbDatabases_throughputSettings_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_mongodbDatabases_collections_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases" + }, + "databaseAccounts_mongodbDatabases_collections": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB collection name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBCollectionCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB collection." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_mongodbDatabases_collections_throughputSettings_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections" + }, + "databaseAccounts_mongodbDatabases_collections_throughputSettings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings" + }, + "databaseAccounts_mongodbDatabases_throughputSettings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings" + }, + "databaseAccounts_sqlDatabases": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB database name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlDatabaseCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB SQL database." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_sqlDatabases_throughputSettings_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_sqlDatabases_containers_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases" + }, + "databaseAccounts_sqlDatabases_containers": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB container name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlContainerCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB container." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_sqlDatabases_containers_throughputSettings_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_sqlDatabases_containers_storedProcedures_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_sqlDatabases_containers_userDefinedFunctions_childResource" + }, + { + "$ref": "#/definitions/databaseAccounts_sqlDatabases_containers_triggers_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" + }, + "databaseAccounts_sqlDatabases_containers_storedProcedures": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB storedProcedure name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlStoredProcedureCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB storedProcedure." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures" + }, + "databaseAccounts_sqlDatabases_containers_throughputSettings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings" + }, + "databaseAccounts_sqlDatabases_containers_triggers": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB trigger name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlTriggerCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB trigger." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers" + }, + "databaseAccounts_sqlDatabases_containers_userDefinedFunctions": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB userDefinedFunction name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlUserDefinedFunctionCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB userDefinedFunction." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions" + }, + "databaseAccounts_sqlDatabases_throughputSettings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings" + }, + "databaseAccounts_tables": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB table name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/tables" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TableCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Table." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/databaseAccounts_tables_throughputSettings_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/tables" + }, + "databaseAccounts_tables_throughputSettings": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings" + } + }, + "definitions": { + "Capability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB capability. For example, \"name\": \"EnableCassandra\". Current values also include \"EnableTable\" and \"EnableGremlin\"." + } + }, + "description": "Cosmos DB capability object" + }, + "CassandraKeyspaceCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraKeyspaceResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Cassandra keyspace resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace." + }, + "CassandraKeyspaceResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra keyspace" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB Cassandra keyspace resource object" + }, + "CassandraPartitionKey": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table partition key" + } + }, + "description": "Cosmos DB Cassandra table partition key" + }, + "CassandraSchema": { + "type": "object", + "properties": { + "columns": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Column" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Cassandra table columns." + }, + "partitionKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/CassandraPartitionKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of partition key." + }, + "clusterKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of cluster key." + } + }, + "description": "Cosmos DB Cassandra table schema" + }, + "CassandraTableCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraTableResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Cassandra table resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra table." + }, + "CassandraTableResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table" + }, + "defaultTtl": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Time to live of the Cosmos DB Cassandra table" + }, + "schema": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraSchema" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Cassandra table schema" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB Cassandra table resource object" + }, + "ClusterKey": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table cluster key" + }, + "orderBy": { + "type": "string", + "description": "Order of the Cosmos DB Cassandra table cluster key, only support \"Asc\" and \"Desc\"" + } + }, + "description": "Cosmos DB Cassandra table cluster key" + }, + "Column": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table column" + }, + "type": { + "type": "string", + "description": "Type of the Cosmos DB Cassandra table column" + } + }, + "description": "Cosmos DB Cassandra table column" + }, + "ConflictResolutionPolicy": { + "type": "object", + "properties": { + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "LastWriterWins", + "Custom" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the conflict resolution mode." + }, + "conflictResolutionPath": { + "type": "string", + "description": "The conflict resolution path in the case of LastWriterWins mode." + }, + "conflictResolutionProcedure": { + "type": "string", + "description": "The procedure to resolve conflicts in the case of custom mode." + } + }, + "description": "The conflict resolution policy for the container." + }, + "ConsistencyPolicy": { + "type": "object", + "properties": { + "defaultConsistencyLevel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Eventual", + "Session", + "BoundedStaleness", + "Strong", + "ConsistentPrefix" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The default consistency level and configuration settings of the Cosmos DB account." + }, + "maxStalenessPrefix": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 2147483647 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + }, + "maxIntervalInSeconds": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 86400 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + } + }, + "required": [ + "defaultConsistencyLevel" + ], + "description": "The consistency policy for the Cosmos DB database account." + }, + "ContainerPartitionKey": { + "type": "object", + "properties": { + "paths": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of paths using which data within the container can be partitioned" + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Hash", + "Range" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the kind of algorithm used for partitioning." + } + }, + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "DatabaseAccountCreateUpdateProperties": { + "type": "object", + "properties": { + "consistencyPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ConsistencyPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The consistency policy for the Cosmos DB database account." + }, + "locations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Location" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "An array that contains the georeplication locations enabled for the Cosmos DB account." + }, + "databaseAccountOfferType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The offer type for the database" + }, + "ipRangeFilter": { + "type": "string", + "description": "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": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules." + }, + "enableAutomaticFailover": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "capabilities": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Capability" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Cosmos DB capabilities for the account" + }, + "virtualNetworkRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account." + }, + "enableMultipleWriteLocations": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables the account to write in multiple locations" + }, + "enableCassandraConnector": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables the cassandra connector on the Cosmos DB C* account" + }, + "connectorOffer": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Small" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The cassandra connector offer type for the Cosmos DB database C* account." + } + }, + "required": [ + "locations", + "databaseAccountOfferType" + ], + "description": "Properties to create and update Azure Cosmos DB database accounts." + }, + "databaseAccounts_cassandraKeyspaces_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB keyspace name." + }, + "type": { + "type": "string", + "enum": [ + "cassandraKeyspaces" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraKeyspaceCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces" + }, + "databaseAccounts_cassandraKeyspaces_tables_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB table name." + }, + "type": { + "type": "string", + "enum": [ + "tables" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CassandraTableCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Cassandra table." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables" + }, + "databaseAccounts_cassandraKeyspaces_tables_throughputSettings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings" + }, + "databaseAccounts_cassandraKeyspaces_throughputSettings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings" + }, + "databaseAccounts_gremlinDatabases_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB database name." + }, + "type": { + "type": "string", + "enum": [ + "gremlinDatabases" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinDatabaseCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin database." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases" + }, + "databaseAccounts_gremlinDatabases_graphs_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB graph name." + }, + "type": { + "type": "string", + "enum": [ + "graphs" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinGraphCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin graph." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs" + }, + "databaseAccounts_gremlinDatabases_graphs_throughputSettings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings" + }, + "databaseAccounts_gremlinDatabases_throughputSettings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings" + }, + "databaseAccounts_mongodbDatabases_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB database name." + }, + "type": { + "type": "string", + "enum": [ + "mongodbDatabases" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBDatabaseCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB database." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases" + }, + "databaseAccounts_mongodbDatabases_collections_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB collection name." + }, + "type": { + "type": "string", + "enum": [ + "collections" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBCollectionCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB collection." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections" + }, + "databaseAccounts_mongodbDatabases_collections_throughputSettings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings" + }, + "databaseAccounts_mongodbDatabases_throughputSettings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings" + }, + "databaseAccounts_sqlDatabases_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB database name." + }, + "type": { + "type": "string", + "enum": [ + "sqlDatabases" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlDatabaseCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB SQL database." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases" + }, + "databaseAccounts_sqlDatabases_containers_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB container name." + }, + "type": { + "type": "string", + "enum": [ + "containers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlContainerCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB container." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" + }, + "databaseAccounts_sqlDatabases_containers_storedProcedures_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB storedProcedure name." + }, + "type": { + "type": "string", + "enum": [ + "storedProcedures" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlStoredProcedureCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB storedProcedure." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures" + }, + "databaseAccounts_sqlDatabases_containers_throughputSettings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings" + }, + "databaseAccounts_sqlDatabases_containers_triggers_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB trigger name." + }, + "type": { + "type": "string", + "enum": [ + "triggers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlTriggerCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB trigger." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers" + }, + "databaseAccounts_sqlDatabases_containers_userDefinedFunctions_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB userDefinedFunction name." + }, + "type": { + "type": "string", + "enum": [ + "userDefinedFunctions" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlUserDefinedFunctionCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB userDefinedFunction." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions" + }, + "databaseAccounts_sqlDatabases_throughputSettings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings" + }, + "databaseAccounts_tables_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cosmos DB table name." + }, + "type": { + "type": "string", + "enum": [ + "tables" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/TableCreateUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to create and update Azure Cosmos DB Table." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/tables" + }, + "databaseAccounts_tables_throughputSettings_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "throughputSettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-08-01" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings" + }, + "ExcludedPath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + } + } + }, + "GremlinDatabaseCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinDatabaseResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Gremlin database resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin database." + }, + "GremlinDatabaseResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin database" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB Gremlin database resource object" + }, + "GremlinGraphCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/GremlinGraphResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB Gremlin graph resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Gremlin graph." + }, + "GremlinGraphResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin graph" + }, + "indexingPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/IndexingPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB indexing policy" + }, + "partitionKey": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerPartitionKey" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UniqueKeyPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ConflictResolutionPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The conflict resolution policy for the container." + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB Gremlin graph resource object" + }, + "IncludedPath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "indexes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Indexes" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of indexes for this path" + } + }, + "description": "The paths that are included in indexing" + }, + "Indexes": { + "type": "object", + "properties": { + "dataType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "String", + "Number", + "Point", + "Polygon", + "LineString", + "MultiPolygon" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The datatype for which the indexing behavior is applied to." + }, + "precision": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The precision of the index. -1 is maximum precision." + }, + "kind": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Hash", + "Range", + "Spatial" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the type of index." + } + }, + "description": "The indexes for the path." + }, + "IndexingPolicy": { + "type": "object", + "properties": { + "automatic": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the indexing policy is automatic" + }, + "indexingMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Consistent", + "Lazy", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates the indexing mode." + }, + "includedPaths": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/IncludedPath" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of paths to include in the indexing" + }, + "excludedPaths": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ExcludedPath" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of paths to exclude from indexing" + } + }, + "description": "Cosmos DB indexing policy" + }, + "Location": { + "type": "object", + "properties": { + "locationName": { + "type": "string", + "description": "The name of the region." + }, + "provisioningState": { + "type": "string", + "description": "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." + }, + "failoverPriority": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "isZoneRedundant": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Flag to indicate whether or not this region is an AvailabilityZone region" + } + }, + "description": "A region in which the Azure Cosmos DB database account is deployed." + }, + "MongoDBCollectionCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBCollectionResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB MongoDB collection resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB collection." + }, + "MongoDBCollectionResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB collection" + }, + "shardKey": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The shard key and partition kind pair, only support \"Hash\" partition kind" + }, + "indexes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/MongoIndex" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of index keys" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB MongoDB collection resource object" + }, + "MongoDBDatabaseCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/MongoDBDatabaseResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB MongoDB database resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB MongoDB database." + }, + "MongoDBDatabaseResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB database" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB MongoDB database resource object" + }, + "MongoIndex": { + "type": "object", + "properties": { + "key": { + "oneOf": [ + { + "$ref": "#/definitions/MongoIndexKeys" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB MongoDB collection resource object" + }, + "options": { + "oneOf": [ + { + "$ref": "#/definitions/MongoIndexOptions" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB MongoDB collection index options" + } + }, + "description": "Cosmos DB MongoDB collection index key" + }, + "MongoIndexKeys": { + "type": "object", + "properties": { + "keys": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of keys for each MongoDB collection in the Azure Cosmos DB service" + } + }, + "description": "Cosmos DB MongoDB collection resource object" + }, + "MongoIndexOptions": { + "type": "object", + "properties": { + "expireAfterSeconds": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Expire after seconds" + }, + "unique": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Is unique or not" + } + }, + "description": "Cosmos DB MongoDB collection index options" + }, + "SqlContainerCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/SqlContainerResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB SQL container resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB container." + }, + "SqlContainerResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL container" + }, + "indexingPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/IndexingPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB indexing policy" + }, + "partitionKey": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerPartitionKey" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UniqueKeyPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ConflictResolutionPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The conflict resolution policy for the container." + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB SQL container resource object" + }, + "SqlDatabaseCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/SqlDatabaseResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB SQL database resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB SQL database." + }, + "SqlDatabaseResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL database" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB SQL database resource object" + }, + "SqlStoredProcedureCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/SqlStoredProcedureResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB SQL storedProcedure resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB storedProcedure." + }, + "SqlStoredProcedureResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL storedProcedure" + }, + "body": { + "type": "string", + "description": "Body of the Stored Procedure" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB SQL storedProcedure resource object" + }, + "SqlTriggerCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/SqlTriggerResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB SQL trigger resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB trigger." + }, + "SqlTriggerResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL trigger" + }, + "body": { + "type": "string", + "description": "Body of the Trigger" + }, + "triggerType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Pre", + "Post" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of the Trigger." + }, + "triggerOperation": { + "oneOf": [ + { + "type": "string", + "enum": [ + "All", + "Create", + "Update", + "Delete", + "Replace" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The operation the trigger is associated with." + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB SQL trigger resource object" + }, + "SqlUserDefinedFunctionCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/SqlUserDefinedFunctionResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB SQL userDefinedFunction resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB userDefinedFunction." + }, + "SqlUserDefinedFunctionResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL userDefinedFunction" + }, + "body": { + "type": "string", + "description": "Body of the User Defined Function" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB SQL userDefinedFunction resource object" + }, + "TableCreateUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/TableResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB table resource object" + }, + "options": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + } + }, + "required": [ + "resource", + "options" + ], + "description": "Properties to create and update Azure Cosmos DB Table." + }, + "TableResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB table" + } + }, + "required": [ + "id" + ], + "description": "Cosmos DB table resource object" + }, + "ThroughputSettingsResource": { + "type": "object", + "properties": { + "throughput": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value of the Cosmos DB resource throughput" + } + }, + "required": [ + "throughput" + ], + "description": "Cosmos DB resource throughput object" + }, + "ThroughputSettingsUpdateProperties": { + "type": "object", + "properties": { + "resource": { + "oneOf": [ + { + "$ref": "#/definitions/ThroughputSettingsResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cosmos DB resource throughput object" + } + }, + "required": [ + "resource" + ], + "description": "Properties to update Azure Cosmos DB resource throughput." + }, + "UniqueKey": { + "type": "object", + "properties": { + "paths": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of paths must be unique for each document in the Azure Cosmos DB service" + } + }, + "description": "The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service." + }, + "UniqueKeyPolicy": { + "type": "object", + "properties": { + "uniqueKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/UniqueKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service." + } + }, + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "VirtualNetworkRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}." + }, + "ignoreMissingVNetServiceEndpoint": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Create firewall rule before the virtual network has vnet service endpoint enabled." + } + }, + "description": "Virtual Network ACL Rule object" + } + } +} diff --git a/test/Resource/Expected/Microsoft.EnterpriseKnowledgeGraph/2018-12-03/Microsoft.EnterpriseKnowledgeGraph.json b/test/Resource/Expected/Microsoft.EnterpriseKnowledgeGraph/2018-12-03/Microsoft.EnterpriseKnowledgeGraph.json new file mode 100644 index 0000000..12c3005 --- /dev/null +++ b/test/Resource/Expected/Microsoft.EnterpriseKnowledgeGraph/2018-12-03/Microsoft.EnterpriseKnowledgeGraph.json @@ -0,0 +1,143 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-12-03/Microsoft.EnterpriseKnowledgeGraph.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.EnterpriseKnowledgeGraph", + "description": "Microsoft EnterpriseKnowledgeGraph Resource Types", + "resourceDefinitions": { + "services": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the EnterpriseKnowledgeGraph resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EnterpriseKnowledgeGraph/services" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-12-03" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SKU of the EnterpriseKnowledgeGraph service account." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EnterpriseKnowledgeGraphProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters to provide for the EnterpriseKnowledgeGraph." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EnterpriseKnowledgeGraph/services" + } + }, + "definitions": { + "EnterpriseKnowledgeGraphProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the EnterpriseKnowledgeGraph" + }, + "metadata": { + "type": "object", + "properties": {}, + "description": "Specifies the metadata of the resource." + }, + "provisioningState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Creating", + "Deleting", + "Failed", + "Succeeded" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The state of EnterpriseKnowledgeGraph provisioning." + } + }, + "description": "The parameters to provide for the EnterpriseKnowledgeGraph." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "F0", + "S1" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "required": [ + "name" + ], + "description": "The SKU of the EnterpriseKnowledgeGraph service account." + } + } +} diff --git a/test/Resource/Expected/Microsoft.EventHub/2014-09-01/Microsoft.EventHub.json b/test/Resource/Expected/Microsoft.EventHub/2014-09-01/Microsoft.EventHub.json new file mode 100644 index 0000000..03df465 --- /dev/null +++ b/test/Resource/Expected/Microsoft.EventHub/2014-09-01/Microsoft.EventHub.json @@ -0,0 +1,664 @@ +{ + "id": "https://schema.management.azure.com/schemas/2014-09-01/Microsoft.EventHub.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.EventHub", + "description": "Microsoft EventHub Resource Types", + "resourceDefinitions": { + "namespaces": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 6, + "maxLength": 50, + "description": "The Namespace name" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2014-09-01" + ] + }, + "location": { + "type": "string", + "description": "Namespace location." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SKU parameters supplied to the create Namespace operation" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Namespace tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NamespaceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the Namespace supplied for create or update Namespace operation" + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/namespaces_AuthorizationRules_childResource" + }, + { + "$ref": "#/definitions/namespaces_eventhubs_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.EventHub/namespaces" + }, + "namespaces_AuthorizationRules": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "The authorization rule name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces/AuthorizationRules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2014-09-01" + ] + }, + "location": { + "type": "string", + "description": "Data center location." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update SharedAccessAuthorizationRule" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/AuthorizationRules" + }, + "namespaces_eventhubs": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "The Event Hub name" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces/eventhubs" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2014-09-01" + ] + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EventHubProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to the Create Or Update Event Hub operation." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/namespaces_eventhubs_authorizationRules_childResource" + }, + { + "$ref": "#/definitions/namespaces_eventhubs_consumergroups_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/eventhubs" + }, + "namespaces_eventhubs_authorizationRules": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "The authorization rule name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces/eventhubs/authorizationRules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2014-09-01" + ] + }, + "location": { + "type": "string", + "description": "Data center location." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update SharedAccessAuthorizationRule" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/eventhubs/authorizationRules" + }, + "namespaces_eventhubs_consumergroups": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "The consumer group name" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces/eventhubs/consumergroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2014-09-01" + ] + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ConsumerGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to the Create Or Update Consumer Group operation." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/eventhubs/consumergroups" + } + }, + "definitions": { + "ConsumerGroupProperties": { + "type": "object", + "properties": { + "userMetadata": { + "type": "string", + "description": "The user metadata." + } + }, + "description": "Properties supplied to the Create Or Update Consumer Group operation." + }, + "EventHubProperties": { + "type": "object", + "properties": { + "messageRetentionInDays": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Number of days to retain the events for this Event Hub." + }, + "partitionCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Number of partitions created for the Event Hub." + }, + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Active", + "Disabled", + "Restoring", + "SendDisabled", + "ReceiveDisabled", + "Creating", + "Deleting", + "Renaming", + "Unknown" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enumerates the possible values for the status of the Event Hub." + } + }, + "description": "Properties supplied to the Create Or Update Event Hub operation." + }, + "NamespaceProperties": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Unknown", + "Creating", + "Created", + "Activating", + "Enabling", + "Active", + "Disabling", + "Disabled", + "SoftDeleting", + "SoftDeleted", + "Removing", + "Removed", + "Failed" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "State of the Namespace." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the Namespace." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The time the Namespace was created." + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "description": "The time the Namespace was updated." + }, + "serviceBusEndpoint": { + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether this instance is enabled." + } + }, + "description": "Properties of the Namespace supplied for create or update Namespace operation" + }, + "namespaces_AuthorizationRules_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The authorization rule name." + }, + "type": { + "type": "string", + "enum": [ + "AuthorizationRules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2014-09-01" + ] + }, + "location": { + "type": "string", + "description": "Data center location." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update SharedAccessAuthorizationRule" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/AuthorizationRules" + }, + "namespaces_eventhubs_authorizationRules_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The authorization rule name." + }, + "type": { + "type": "string", + "enum": [ + "authorizationRules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2014-09-01" + ] + }, + "location": { + "type": "string", + "description": "Data center location." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update SharedAccessAuthorizationRule" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/eventhubs/authorizationRules" + }, + "namespaces_eventhubs_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Event Hub name" + }, + "type": { + "type": "string", + "enum": [ + "eventhubs" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2014-09-01" + ] + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EventHubProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to the Create Or Update Event Hub operation." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/eventhubs" + }, + "namespaces_eventhubs_consumergroups_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The consumer group name" + }, + "type": { + "type": "string", + "enum": [ + "consumergroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2014-09-01" + ] + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ConsumerGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to the Create Or Update Consumer Group operation." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/eventhubs/consumergroups" + }, + "SharedAccessAuthorizationRuleProperties": { + "type": "object", + "properties": { + "rights": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Manage", + "Send", + "Listen" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The rights associated with the rule." + } + }, + "required": [ + "rights" + ], + "description": "Properties supplied to create or update SharedAccessAuthorizationRule" + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic", + "Standard" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Name of this SKU." + }, + "tier": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic", + "Standard", + "Premium" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The billing tier of this particular SKU." + }, + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Event Hubs throughput units." + } + }, + "required": [ + "tier" + ], + "description": "SKU parameters supplied to the create Namespace operation" + } + } +} diff --git a/test/Resource/Expected/EventHub/2015-08-01/Microsoft.EventHub.json b/test/Resource/Expected/Microsoft.EventHub/2015-08-01/Microsoft.EventHub.json similarity index 88% rename from test/Resource/Expected/EventHub/2015-08-01/Microsoft.EventHub.json rename to test/Resource/Expected/Microsoft.EventHub/2015-08-01/Microsoft.EventHub.json index 8ec1260..6727ff6 100644 --- a/test/Resource/Expected/EventHub/2015-08-01/Microsoft.EventHub.json +++ b/test/Resource/Expected/Microsoft.EventHub/2015-08-01/Microsoft.EventHub.json @@ -35,9 +35,10 @@ "$ref": "#/definitions/Sku" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "SKU parameters supplied to the create Namespace operation" }, "tags": { "oneOf": [ @@ -49,7 +50,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Namespace tags." @@ -60,9 +61,10 @@ "$ref": "#/definitions/NamespaceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties of the Namespace supplied for create or update Namespace operation" }, "resources": { "type": "array", @@ -118,9 +120,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties supplied to create or update SharedAccessAuthorizationRule" } }, "required": [ @@ -162,9 +165,10 @@ "$ref": "#/definitions/EventHubProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties supplied to the Create Or Update Event Hub operation." }, "resources": { "type": "array", @@ -220,9 +224,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties supplied to create or update SharedAccessAuthorizationRule" } }, "required": [ @@ -264,9 +269,10 @@ "$ref": "#/definitions/ConsumerGroupProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties supplied to the Create Or Update Consumer Group operation." } }, "required": [ @@ -299,7 +305,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Number of days to retain the events for this Event Hub." @@ -310,7 +316,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Number of partitions created for the Event Hub." @@ -332,7 +338,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Enumerates the possible values for the status of the Event Hub." @@ -364,7 +370,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "State of the Namespace." @@ -393,7 +399,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Specifies whether this instance is enabled." @@ -430,9 +436,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties supplied to create or update SharedAccessAuthorizationRule" } }, "required": [ @@ -472,9 +479,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties supplied to create or update SharedAccessAuthorizationRule" } }, "required": [ @@ -514,9 +522,10 @@ "$ref": "#/definitions/EventHubProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties supplied to the Create Or Update Event Hub operation." } }, "required": [ @@ -557,9 +566,10 @@ "$ref": "#/definitions/ConsumerGroupProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties supplied to the Create Or Update Consumer Group operation." } }, "required": [ @@ -588,7 +598,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The rights associated with the rule." @@ -612,7 +622,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Name of this SKU." @@ -628,7 +638,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The billing tier of this particular SKU." @@ -639,7 +649,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The Event Hubs throughput units." diff --git a/test/Resource/Expected/EventHub/2017-04-01/Microsoft.EventHub.json b/test/Resource/Expected/Microsoft.EventHub/2017-04-01/Microsoft.EventHub.json similarity index 70% rename from test/Resource/Expected/EventHub/2017-04-01/Microsoft.EventHub.json rename to test/Resource/Expected/Microsoft.EventHub/2017-04-01/Microsoft.EventHub.json index f241513..2fcab36 100644 --- a/test/Resource/Expected/EventHub/2017-04-01/Microsoft.EventHub.json +++ b/test/Resource/Expected/Microsoft.EventHub/2017-04-01/Microsoft.EventHub.json @@ -39,7 +39,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Resource tags" @@ -50,10 +50,10 @@ "$ref": "#/definitions/Sku" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of sku resource" + "description": "SKU parameters supplied to the create namespace operation" }, "properties": { "oneOf": [ @@ -61,7 +61,7 @@ "$ref": "#/definitions/EHNamespaceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Namespace properties supplied for create namespace operation." @@ -73,6 +73,9 @@ { "$ref": "#/definitions/namespaces_AuthorizationRules_childResource" }, + { + "$ref": "#/definitions/namespaces_networkRuleSets_childResource" + }, { "$ref": "#/definitions/namespaces_disasterRecoveryConfigs_childResource" }, @@ -117,7 +120,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties supplied to create or update AuthorizationRule" @@ -158,7 +161,7 @@ "$ref": "#/definitions/ArmDisasterRecoveryProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" @@ -198,7 +201,7 @@ "$ref": "#/definitions/EventhubProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties supplied to the Create Or Update Event Hub operation." @@ -251,7 +254,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties supplied to create or update AuthorizationRule" @@ -292,7 +295,7 @@ "$ref": "#/definitions/ConsumerGroupProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Single item in List or Get Consumer group operation" @@ -305,6 +308,52 @@ "properties" ], "description": "Microsoft.EventHub/namespaces/eventhubs/consumergroups" + }, + "namespaces_networkRuleSets": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces/networkRuleSets" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-04-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NetworkRuleSet properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/networkRuleSets" } }, "definitions": { @@ -313,7 +362,7 @@ "properties": { "partnerNamespace": { "type": "string", - "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairning" + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" }, "alternateName": { "type": "string", @@ -339,7 +388,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The rights associated with the rule." @@ -359,7 +408,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether capture description is enabled. " @@ -374,10 +423,10 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Enumerates the possible values for the encoding format of capture description." + "description": "Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version." }, "intervalInSeconds": { "oneOf": [ @@ -387,7 +436,7 @@ "maximum": 900 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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" @@ -400,7 +449,7 @@ "maximum": 524288000 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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" @@ -411,10 +460,21 @@ "$ref": "#/definitions/Destination" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of Destination where capture will be stored. (Storage Account, Blob Names)" + "description": "Capture storage details for capture description" + }, + "skipEmptyArchives": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A value that indicates whether to Skip Empty Archives" } }, "description": "Properties to configure capture description for eventhub" @@ -424,7 +484,7 @@ "properties": { "userMetadata": { "type": "string", - "description": "Usermetadata 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." + "description": "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." } }, "description": "Single item in List or Get Consumer group operation" @@ -442,10 +502,10 @@ "$ref": "#/definitions/DestinationProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties describing the storage account, blob container and acrchive anme format for capture destination" + "description": "Properties describing the storage account, blob container and archive name format for capture destination" } }, "description": "Capture storage details for capture description" @@ -466,7 +526,7 @@ "description": "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" } }, - "description": "Properties describing the storage account, blob container and acrchive anme format for capture destination" + "description": "Properties describing the storage account, blob container and archive name format for capture destination" }, "EHNamespaceProperties": { "type": "object", @@ -477,7 +537,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." @@ -490,10 +550,21 @@ "maximum": 20 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Upper limit of throughput units when AutoInflate is enabled, vaule should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + }, + "kafkaEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value that indicates whether Kafka is enabled for eventhub namespace." } }, "description": "Namespace properties supplied for create namespace operation." @@ -508,7 +579,7 @@ "minimum": 1 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Number of days to retain the events for this Event Hub, value should be 1 to 7 days" @@ -520,7 +591,7 @@ "minimum": 1 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions." @@ -542,7 +613,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Enumerates the possible values for the status of the Event Hub." @@ -553,10 +624,10 @@ "$ref": "#/definitions/CaptureDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of capture description" + "description": "Properties to configure capture description for eventhub" } }, "description": "Properties supplied to the Create Or Update Event Hub operation." @@ -586,7 +657,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties supplied to create or update AuthorizationRule" @@ -625,7 +696,7 @@ "$ref": "#/definitions/ArmDisasterRecoveryProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" @@ -664,7 +735,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties supplied to create or update AuthorizationRule" @@ -703,7 +774,7 @@ "$ref": "#/definitions/EventhubProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties supplied to the Create Or Update Event Hub operation." @@ -742,7 +813,7 @@ "$ref": "#/definitions/ConsumerGroupProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Single item in List or Get Consumer group operation" @@ -756,6 +827,153 @@ ], "description": "Microsoft.EventHub/namespaces/eventhubs/consumergroups" }, + "namespaces_networkRuleSets_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "networkRuleSets" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-04-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NetworkRuleSet properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/networkRuleSets" + }, + "NetworkRuleSetProperties": { + "type": "object", + "properties": { + "defaultAction": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Allow", + "Deny" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Default Action for Network Rule Set." + }, + "virtualNetworkRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of IpRules" + } + }, + "description": "NetworkRuleSet properties" + }, + "NWRuleSetIpRules": { + "type": "object", + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Allow" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The IP Filter Action." + } + }, + "description": "Description of NetWorkRuleSet - IpRules resource." + }, + "NWRuleSetVirtualNetworkRules": { + "type": "object", + "properties": { + "subnet": { + "oneOf": [ + { + "$ref": "#/definitions/Subnet" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied for Subnet" + }, + "ignoreMissingVnetServiceEndpoint": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value that indicates whether to ignore missing VNet Service Endpoint" + } + }, + "description": "Description of VirtualNetworkRules - NetworkRules resource." + }, "Sku": { "type": "object", "properties": { @@ -769,7 +987,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Name of this SKU." @@ -784,7 +1002,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The billing tier of this particular SKU." @@ -797,16 +1015,29 @@ "maximum": 20 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Event Hubs throughput units, vaule should be 0 to 20 throughput units." + "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." } }, "required": [ "name" ], "description": "SKU parameters supplied to the create namespace operation" + }, + "Subnet": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "required": [ + "id" + ], + "description": "Properties supplied for Subnet" } } } diff --git a/test/Resource/Expected/Microsoft.EventHub/2018-01-01-preview/Microsoft.EventHub.json b/test/Resource/Expected/Microsoft.EventHub/2018-01-01-preview/Microsoft.EventHub.json new file mode 100644 index 0000000..04dde92 --- /dev/null +++ b/test/Resource/Expected/Microsoft.EventHub/2018-01-01-preview/Microsoft.EventHub.json @@ -0,0 +1,631 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-01-01-preview/Microsoft.EventHub.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.EventHub", + "description": "Microsoft EventHub Resource Types", + "resourceDefinitions": { + "clusters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 6, + "maxLength": 50, + "description": "The name of the Event Hubs Cluster." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/clusters" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.EventHub/clusters" + }, + "namespaces": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 6, + "maxLength": 50, + "description": "The Namespace name" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SKU parameters supplied to the create namespace operation" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EHNamespaceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Namespace properties supplied for create namespace operation." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/namespaces_ipfilterrules_childResource" + }, + { + "$ref": "#/definitions/namespaces_virtualnetworkrules_childResource" + }, + { + "$ref": "#/definitions/namespaces_networkRuleSets_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces" + }, + "namespaces_ipfilterrules": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The IP Filter Rule name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces/ipfilterrules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IpFilterRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update IpFilterRules" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/ipfilterrules" + }, + "namespaces_networkRuleSets": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces/networkRuleSets" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NetworkRuleSet properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/networkRuleSets" + }, + "namespaces_virtualnetworkrules": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The Virtual Network Rule name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.EventHub/namespaces/virtualnetworkrules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualNetworkRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update VirtualNetworkRules" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/virtualnetworkrules" + } + }, + "definitions": { + "EHNamespaceProperties": { + "type": "object", + "properties": { + "isAutoInflateEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." + }, + "maximumThroughputUnits": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 20 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + }, + "kafkaEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value that indicates whether Kafka is enabled for eventhub namespace." + }, + "zoneRedundant": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones." + } + }, + "description": "Namespace properties supplied for create namespace operation." + }, + "IpFilterRuleProperties": { + "type": "object", + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Accept", + "Reject" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The IP Filter Action." + }, + "filterName": { + "type": "string", + "description": "IP Filter name" + } + }, + "description": "Properties supplied to create or update IpFilterRules" + }, + "namespaces_ipfilterrules_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The IP Filter Rule name." + }, + "type": { + "type": "string", + "enum": [ + "ipfilterrules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IpFilterRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update IpFilterRules" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/ipfilterrules" + }, + "namespaces_networkRuleSets_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "networkRuleSets" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NetworkRuleSet properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/networkRuleSets" + }, + "namespaces_virtualnetworkrules_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Virtual Network Rule name." + }, + "type": { + "type": "string", + "enum": [ + "virtualnetworkrules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualNetworkRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update VirtualNetworkRules" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.EventHub/namespaces/virtualnetworkrules" + }, + "NetworkRuleSetProperties": { + "type": "object", + "properties": { + "defaultAction": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Allow", + "Deny" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Default Action for Network Rule Set." + }, + "virtualNetworkRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of IpRules" + } + }, + "description": "NetworkRuleSet properties" + }, + "NWRuleSetIpRules": { + "type": "object", + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Allow" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The IP Filter Action." + } + }, + "description": "The response from the List namespace operation." + }, + "NWRuleSetVirtualNetworkRules": { + "type": "object", + "properties": { + "subnet": { + "oneOf": [ + { + "$ref": "#/definitions/Subnet" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied for Subnet" + }, + "ignoreMissingVnetServiceEndpoint": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" + } + }, + "description": "The response from the List namespace operation." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Dedicated", + "Basic", + "Standard" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Name of this SKU." + }, + "tier": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic", + "Standard" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The billing tier of this particular SKU." + }, + "capacity": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 20 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters supplied to the create namespace operation" + }, + "Subnet": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied for Subnet" + }, + "VirtualNetworkRuleProperties": { + "type": "object", + "properties": { + "virtualNetworkSubnetId": { + "type": "string", + "description": "ARM ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied to create or update VirtualNetworkRules" + } + } +} diff --git a/test/Resource/Expected/Microsoft.IoTSpaces/2017-10-01-preview/Microsoft.IoTSpaces.json b/test/Resource/Expected/Microsoft.IoTSpaces/2017-10-01-preview/Microsoft.IoTSpaces.json new file mode 100644 index 0000000..dfa2128 --- /dev/null +++ b/test/Resource/Expected/Microsoft.IoTSpaces/2017-10-01-preview/Microsoft.IoTSpaces.json @@ -0,0 +1,148 @@ +{ + "id": "https://schema.management.azure.com/schemas/2017-10-01-preview/Microsoft.IoTSpaces.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.IoTSpaces", + "description": "Microsoft IoTSpaces Resource Types", + "resourceDefinitions": { + "Graph": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 64, + "description": "The name of the IoTSpaces instance." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.IoTSpaces/Graph" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-10-01-preview" + ] + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IoTSpacesProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of an IoTSpaces instance." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/IoTSpacesSkuInfo" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Information about the SKU of the IoTSpaces instance." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties", + "sku" + ], + "description": "Microsoft.IoTSpaces/Graph" + } + }, + "definitions": { + "IoTSpacesProperties": { + "type": "object", + "properties": { + "storageContainer": { + "oneOf": [ + { + "$ref": "#/definitions/StorageContainerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the Azure Storage Container for file archive." + } + }, + "description": "The properties of an IoTSpaces instance." + }, + "IoTSpacesSkuInfo": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "F1", + "S1", + "S2", + "S3" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the SKU." + } + }, + "required": [ + "name" + ], + "description": "Information about the SKU of the IoTSpaces instance." + }, + "StorageContainerProperties": { + "type": "object", + "properties": { + "connectionString": { + "type": "string", + "description": "The connection string of the storage account." + }, + "subscriptionId": { + "type": "string", + "description": "The subscription identifier of the storage account." + }, + "resourceGroup": { + "type": "string", + "description": "The name of the resource group of the storage account." + }, + "containerName": { + "type": "string", + "description": "The name of storage container in the storage account." + } + }, + "description": "The properties of the Azure Storage Container for file archive." + } + } +} diff --git a/test/Resource/Expected/Microsoft.LabServices/2018-10-15/Microsoft.LabServices.json b/test/Resource/Expected/Microsoft.LabServices/2018-10-15/Microsoft.LabServices.json new file mode 100644 index 0000000..c2e8ec8 --- /dev/null +++ b/test/Resource/Expected/Microsoft.LabServices/2018-10-15/Microsoft.LabServices.json @@ -0,0 +1,962 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-10-15/Microsoft.LabServices.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.LabServices", + "description": "Microsoft LabServices Resource Types", + "resourceDefinitions": { + "labaccounts": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the lab Account." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.LabServices/labaccounts" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/LabAccountProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of a Lab Account." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/labaccounts_galleryimages_childResource" + }, + { + "$ref": "#/definitions/labaccounts_labs_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts" + }, + "labaccounts_galleryimages": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the gallery Image." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.LabServices/labaccounts/galleryimages" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The gallery image properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/galleryimages" + }, + "labaccounts_labs": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the lab." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.LabServices/labaccounts/labs" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/LabProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of a Lab." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/labaccounts_labs_environmentsettings_childResource" + }, + { + "$ref": "#/definitions/labaccounts_labs_users_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/labs" + }, + "labaccounts_labs_environmentsettings": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment Setting." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.LabServices/labaccounts/labs/environmentsettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EnvironmentSettingProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of an environment setting" + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/labaccounts_labs_environmentsettings_environments_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/labs/environmentsettings" + }, + "labaccounts_labs_environmentsettings_environments": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.LabServices/labaccounts/labs/environmentsettings/environments" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EnvironmentProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of an environment" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/labs/environmentsettings/environments" + }, + "labaccounts_labs_users": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the user." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.LabServices/labaccounts/labs/users" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/UserProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Lab User properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/labs/users" + } + }, + "definitions": { + "EnvironmentProperties": { + "type": "object", + "properties": { + "resourceSets": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceSet" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents a VM and the setting Id it was created for." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning status of the resource." + }, + "uniqueIdentifier": { + "type": "string", + "description": "The unique immutable identifier of a resource (Guid)." + } + }, + "description": "Properties of an environment" + }, + "EnvironmentSettingProperties": { + "type": "object", + "properties": { + "configurationState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "NotApplicable", + "Completed" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the user's progress in configuring their environment setting." + }, + "description": { + "type": "string", + "description": "Describes the environment and its resource settings" + }, + "title": { + "type": "string", + "description": "Brief title describing the environment and its resource settings" + }, + "resourceSettings": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents resource specific settings" + }, + "provisioningState": { + "type": "string", + "description": "The provisioning status of the resource." + }, + "uniqueIdentifier": { + "type": "string", + "description": "The unique immutable identifier of a resource (Guid)." + } + }, + "required": [ + "resourceSettings" + ], + "description": "Properties of an environment setting" + }, + "GalleryImageProperties": { + "type": "object", + "properties": { + "isEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether this gallery image is enabled." + }, + "isOverride": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether this gallery has been overridden for this lab account" + }, + "isPlanAuthorized": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the plan has been authorized for programmatic deployment." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning status of the resource." + }, + "uniqueIdentifier": { + "type": "string", + "description": "The unique immutable identifier of a resource (Guid)." + } + }, + "description": "The gallery image properties" + }, + "LabAccountProperties": { + "type": "object", + "properties": { + "enabledRegionSelection": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents if region selection is enabled" + }, + "provisioningState": { + "type": "string", + "description": "The provisioning status of the resource." + }, + "uniqueIdentifier": { + "type": "string", + "description": "The unique immutable identifier of a resource (Guid)." + } + }, + "description": "Properties of a Lab Account." + }, + "labaccounts_galleryimages_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the gallery Image." + }, + "type": { + "type": "string", + "enum": [ + "galleryimages" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The gallery image properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/galleryimages" + }, + "labaccounts_labs_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the lab." + }, + "type": { + "type": "string", + "enum": [ + "labs" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/LabProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of a Lab." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/labs" + }, + "labaccounts_labs_environmentsettings_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment Setting." + }, + "type": { + "type": "string", + "enum": [ + "environmentsettings" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EnvironmentSettingProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of an environment setting" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/labs/environmentsettings" + }, + "labaccounts_labs_environmentsettings_environments_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment." + }, + "type": { + "type": "string", + "enum": [ + "environments" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EnvironmentProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of an environment" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/labs/environmentsettings/environments" + }, + "labaccounts_labs_users_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the user." + }, + "type": { + "type": "string", + "enum": [ + "users" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-15" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/UserProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Lab User properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.LabServices/labaccounts/labs/users" + }, + "LabProperties": { + "type": "object", + "properties": { + "maxUsersInLab": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Maximum number of users allowed in the lab." + }, + "usageQuota": { + "type": "string", + "format": "duration", + "description": "Maximum duration a user can use an environment for in the lab." + }, + "userAccessMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Restricted", + "Open" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Lab user access mode (open to all vs. restricted to those listed on the lab)." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning status of the resource." + }, + "uniqueIdentifier": { + "type": "string", + "description": "The unique immutable identifier of a resource (Guid)." + } + }, + "description": "Properties of a Lab." + }, + "ReferenceVm": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "The username of the virtual machine" + }, + "password": { + "type": "string", + "description": "The password of the virtual machine. This will be set to null in GET resource API" + } + }, + "required": [ + "userName" + ], + "description": "Details of a Reference Vm" + }, + "ResourceSet": { + "type": "object", + "properties": { + "vmResourceId": { + "type": "string", + "description": "VM resource Id for the environment" + }, + "resourceSettingId": { + "type": "string", + "description": "resourceSettingId for the environment" + } + }, + "description": "Represents a VM and the setting Id it was created for." + }, + "ResourceSettings": { + "type": "object", + "properties": { + "galleryImageResourceId": { + "type": "string", + "description": "The resource id of the gallery image used for creating the virtual machine" + }, + "size": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic", + "Standard", + "Performance" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The size of the virtual machine." + }, + "referenceVm": { + "oneOf": [ + { + "$ref": "#/definitions/ReferenceVm" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Details of a Reference Vm" + } + }, + "required": [ + "referenceVm" + ], + "description": "Represents resource specific settings" + }, + "UserProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "The provisioning status of the resource." + }, + "uniqueIdentifier": { + "type": "string", + "description": "The unique immutable identifier of a resource (Guid)." + } + }, + "description": "Lab User properties" + } + } +} diff --git a/test/Resource/Expected/Microsoft.MachineLearningCompute/2017-06-01-preview/Microsoft.MachineLearningCompute.json b/test/Resource/Expected/Microsoft.MachineLearningCompute/2017-06-01-preview/Microsoft.MachineLearningCompute.json new file mode 100644 index 0000000..b155885 --- /dev/null +++ b/test/Resource/Expected/Microsoft.MachineLearningCompute/2017-06-01-preview/Microsoft.MachineLearningCompute.json @@ -0,0 +1,533 @@ +{ + "id": "https://schema.management.azure.com/schemas/2017-06-01-preview/Microsoft.MachineLearningCompute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.MachineLearningCompute", + "description": "Microsoft MachineLearningCompute Resource Types", + "resourceDefinitions": { + "operationalizationClusters": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z][-\\w\\._\\(\\)]+[a-zA-Z0-9]$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the cluster." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.MachineLearningCompute/operationalizationClusters" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OperationalizationClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of an operationalization cluster" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.MachineLearningCompute/operationalizationClusters" + } + }, + "definitions": { + "AcsClusterProperties": { + "type": "object", + "properties": { + "orchestratorType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Kubernetes" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of orchestrator. It cannot be changed once the cluster is created." + }, + "orchestratorProperties": { + "oneOf": [ + { + "$ref": "#/definitions/KubernetesClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Kubernetes cluster specific properties" + }, + "systemServices": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Scoring", + "Batch" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The system services deployed to the cluster" + }, + "agentCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": "2" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of agent nodes in the Container Service. This can be changed to scale the cluster." + }, + "agentVmSize": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Azure VM size of the agent VM nodes. This cannot be changed once the cluster is created." + } + }, + "required": [ + "orchestratorType", + "orchestratorProperties" + ], + "description": "Information about the container service backing the cluster" + }, + "AppInsightsCredentials": { + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "The AppInsights application ID." + }, + "apiKey": { + "type": "string", + "description": "The AppInsights API key. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API." + } + }, + "description": "AppInsights credentials." + }, + "AutoScaleConfiguration": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If auto-scale is enabled for all services. Each service can turn it off individually." + }, + "minReplicas": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "default": "1" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The minimum number of replicas for each service." + }, + "maxReplicas": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "default": "100" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum number of replicas for each service." + }, + "targetUtilization": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The target utilization." + }, + "refreshPeriodInSeconds": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Refresh period in seconds." + } + }, + "description": "AutoScale configuration properties." + }, + "ContainerRegistryProperties": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "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." + } + }, + "description": "Properties of Azure Container Registry." + }, + "GlobalServiceConfiguration": { + "type": "object", + "properties": { + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Unmatched properties from the message are deserialized this collection" + }, + "etag": { + "type": "string", + "description": "The configuration ETag for updates." + }, + "ssl": { + "oneOf": [ + { + "$ref": "#/definitions/SslConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSL configuration. If configured data-plane calls to user services will be exposed over SSL only." + }, + "serviceAuth": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceAuthConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own." + }, + "autoScale": { + "oneOf": [ + { + "$ref": "#/definitions/AutoScaleConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "AutoScale configuration properties." + } + }, + "description": "Global configuration for services in the cluster." + }, + "KubernetesClusterProperties": { + "type": "object", + "properties": { + "servicePrincipal": { + "oneOf": [ + { + "$ref": "#/definitions/ServicePrincipalProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Azure service principal used by Kubernetes for configuring load balancers" + } + }, + "required": [ + "servicePrincipal" + ], + "description": "Kubernetes cluster specific properties" + }, + "OperationalizationClusterProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the cluster." + }, + "clusterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "ACS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The cluster type." + }, + "storageAccount": { + "oneOf": [ + { + "$ref": "#/definitions/StorageAccountProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of Storage Account." + }, + "containerRegistry": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerRegistryProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of Azure Container Registry." + }, + "containerService": { + "oneOf": [ + { + "$ref": "#/definitions/AcsClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Information about the container service backing the cluster" + }, + "appInsights": { + "oneOf": [ + { + "$ref": "#/definitions/AppInsightsCredentials" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "AppInsights credentials." + }, + "globalServiceConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/GlobalServiceConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Global configuration for services in the cluster." + } + }, + "required": [ + "clusterType", + "containerService" + ], + "description": "Properties of an operationalization cluster" + }, + "ServiceAuthConfiguration": { + "type": "object", + "properties": { + "primaryAuthKeyHash": { + "type": "string", + "description": "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": { + "type": "string", + "description": "The secondary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API." + } + }, + "required": [ + "primaryAuthKeyHash", + "secondaryAuthKeyHash" + ], + "description": "Global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own." + }, + "ServicePrincipalProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The service principal client ID" + }, + "secret": { + "type": "string", + "description": "The service principal secret. This is not returned in response of GET/PUT on the resource. To see this please call listKeys." + } + }, + "required": [ + "clientId", + "secret" + ], + "description": "The Azure service principal used by Kubernetes for configuring load balancers" + }, + "SslConfiguration": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSL status. Allowed values are Enabled and Disabled." + }, + "cert": { + "type": "string", + "description": "The SSL cert data in PEM format encoded as base64 string" + }, + "key": { + "type": "string", + "description": "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." + } + }, + "description": "SSL configuration. If configured data-plane calls to user services will be exposed over SSL only." + }, + "StorageAccountProperties": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "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." + } + }, + "description": "Properties of Storage Account." + } + } +} diff --git a/test/Resource/Expected/Microsoft.MachineLearningCompute/2017-08-01-preview/Microsoft.MachineLearningCompute.json b/test/Resource/Expected/Microsoft.MachineLearningCompute/2017-08-01-preview/Microsoft.MachineLearningCompute.json new file mode 100644 index 0000000..5edd29f --- /dev/null +++ b/test/Resource/Expected/Microsoft.MachineLearningCompute/2017-08-01-preview/Microsoft.MachineLearningCompute.json @@ -0,0 +1,566 @@ +{ + "id": "https://schema.management.azure.com/schemas/2017-08-01-preview/Microsoft.MachineLearningCompute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.MachineLearningCompute", + "description": "Microsoft MachineLearningCompute Resource Types", + "resourceDefinitions": { + "operationalizationClusters": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^[a-zA-Z][-\\w\\._\\(\\)]+[a-zA-Z0-9]$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The name of the cluster." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.MachineLearningCompute/operationalizationClusters" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-08-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Specifies the location of the resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains resource tags defined as key/value pairs." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/OperationalizationClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of an operationalization cluster" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.MachineLearningCompute/operationalizationClusters" + } + }, + "definitions": { + "AcsClusterProperties": { + "type": "object", + "properties": { + "orchestratorType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Kubernetes", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Type of orchestrator. It cannot be changed once the cluster is created." + }, + "orchestratorProperties": { + "oneOf": [ + { + "$ref": "#/definitions/KubernetesClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Kubernetes cluster specific properties" + }, + "systemServices": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SystemService" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The system services deployed to the cluster" + }, + "masterCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 5, + "default": "1" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of master nodes in the container service." + }, + "agentCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": "2" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of agent nodes in the Container Service. This can be changed to scale the cluster." + }, + "agentVmSize": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Azure VM size of the agent VM nodes. This cannot be changed once the cluster is created. This list is non exhaustive; refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes for the possible VM sizes." + } + }, + "required": [ + "orchestratorType" + ], + "description": "Information about the container service backing the cluster" + }, + "AppInsightsProperties": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "ARM resource ID of the App Insights." + } + }, + "description": "Properties of App Insights." + }, + "AutoScaleConfiguration": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If auto-scale is enabled for all services. Each service can turn it off individually." + }, + "minReplicas": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "default": "1" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The minimum number of replicas for each service." + }, + "maxReplicas": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "default": "100" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum number of replicas for each service." + }, + "targetUtilization": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The target utilization." + }, + "refreshPeriodInSeconds": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Refresh period in seconds." + } + }, + "description": "AutoScale configuration properties." + }, + "ContainerRegistryProperties": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "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." + } + }, + "description": "Properties of Azure Container Registry." + }, + "GlobalServiceConfiguration": { + "type": "object", + "properties": { + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Unmatched properties from the message are deserialized this collection" + }, + "etag": { + "type": "string", + "description": "The configuration ETag for updates." + }, + "ssl": { + "oneOf": [ + { + "$ref": "#/definitions/SslConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSL configuration. If configured data-plane calls to user services will be exposed over SSL only." + }, + "serviceAuth": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceAuthConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own." + }, + "autoScale": { + "oneOf": [ + { + "$ref": "#/definitions/AutoScaleConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "AutoScale configuration properties." + } + }, + "description": "Global configuration for services in the cluster." + }, + "KubernetesClusterProperties": { + "type": "object", + "properties": { + "servicePrincipal": { + "oneOf": [ + { + "$ref": "#/definitions/ServicePrincipalProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Azure service principal used by Kubernetes for configuring load balancers" + } + }, + "description": "Kubernetes cluster specific properties" + }, + "OperationalizationClusterProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the cluster." + }, + "clusterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "ACS", + "Local" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The cluster type." + }, + "storageAccount": { + "oneOf": [ + { + "$ref": "#/definitions/StorageAccountProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of Storage Account." + }, + "containerRegistry": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerRegistryProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of Azure Container Registry." + }, + "containerService": { + "oneOf": [ + { + "$ref": "#/definitions/AcsClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Information about the container service backing the cluster" + }, + "appInsights": { + "oneOf": [ + { + "$ref": "#/definitions/AppInsightsProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of App Insights." + }, + "globalServiceConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/GlobalServiceConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Global configuration for services in the cluster." + } + }, + "required": [ + "clusterType" + ], + "description": "Properties of an operationalization cluster" + }, + "ServiceAuthConfiguration": { + "type": "object", + "properties": { + "primaryAuthKeyHash": { + "type": "string", + "description": "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": { + "type": "string", + "description": "The secondary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API." + } + }, + "required": [ + "primaryAuthKeyHash", + "secondaryAuthKeyHash" + ], + "description": "Global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own." + }, + "ServicePrincipalProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The service principal client ID" + }, + "secret": { + "type": "string", + "description": "The service principal secret. This is not returned in response of GET/PUT on the resource. To see this please call listKeys." + } + }, + "required": [ + "clientId", + "secret" + ], + "description": "The Azure service principal used by Kubernetes for configuring load balancers" + }, + "SslConfiguration": { + "type": "object", + "properties": { + "status": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSL status. Allowed values are Enabled and Disabled." + }, + "cert": { + "type": "string", + "description": "The SSL cert data in PEM format." + }, + "key": { + "type": "string", + "description": "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." + }, + "cname": { + "type": "string", + "description": "The CName of the certificate." + } + }, + "description": "SSL configuration. If configured data-plane calls to user services will be exposed over SSL only." + }, + "StorageAccountProperties": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "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." + } + }, + "description": "Properties of Storage Account." + }, + "SystemService": { + "type": "object", + "properties": { + "systemServiceType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ScoringFrontEnd", + "BatchFrontEnd" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The system service type." + } + }, + "required": [ + "systemServiceType" + ], + "description": "Information about a system service deployed in the cluster" + } + } +} diff --git a/test/Resource/Expected/Microsoft.Portal/2015-08-01-preview/Microsoft.Portal.json b/test/Resource/Expected/Microsoft.Portal/2015-08-01-preview/Microsoft.Portal.json new file mode 100644 index 0000000..bd48ec4 --- /dev/null +++ b/test/Resource/Expected/Microsoft.Portal/2015-08-01-preview/Microsoft.Portal.json @@ -0,0 +1,268 @@ +{ + "id": "https://schema.management.azure.com/schemas/2015-08-01-preview/Microsoft.Portal.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Portal", + "description": "Microsoft Portal Resource Types", + "resourceDefinitions": { + "dashboards": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 3, + "maxLength": 64, + "description": "The name of the dashboard." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Portal/dashboards" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2015-08-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DashboardProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The shared dashboard properties." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties", + "location" + ], + "description": "Microsoft.Portal/dashboards" + } + }, + "definitions": { + "DashboardLens": { + "type": "object", + "properties": { + "order": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The lens order." + }, + "parts": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DashboardParts" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard parts." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard len's metadata." + } + }, + "required": [ + "order", + "parts" + ], + "description": "A dashboard lens." + }, + "DashboardParts": { + "type": "object", + "properties": { + "position": { + "oneOf": [ + { + "$ref": "#/definitions/DashboardPartsPosition" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part position." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard part's metadata." + } + }, + "required": [ + "position" + ], + "description": "A dashboard part." + }, + "DashboardPartsPosition": { + "type": "object", + "properties": { + "x": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part x coordinate." + }, + "y": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part y coordinate." + }, + "rowSpan": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part row span." + }, + "colSpan": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part column span." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard part's metadata." + } + }, + "required": [ + "x", + "y", + "rowSpan", + "colSpan" + ], + "description": "The dashboard's part position." + }, + "DashboardProperties": { + "type": "object", + "properties": { + "lenses": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DashboardLens" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard lenses." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard metadata." + } + }, + "description": "The shared dashboard properties." + } + } +} diff --git a/test/Resource/Expected/Microsoft.Portal/2018-10-01-preview/Microsoft.Portal.json b/test/Resource/Expected/Microsoft.Portal/2018-10-01-preview/Microsoft.Portal.json new file mode 100644 index 0000000..ce5d710 --- /dev/null +++ b/test/Resource/Expected/Microsoft.Portal/2018-10-01-preview/Microsoft.Portal.json @@ -0,0 +1,268 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-10-01-preview/Microsoft.Portal.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Portal", + "description": "Microsoft Portal Resource Types", + "resourceDefinitions": { + "dashboards": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 3, + "maxLength": 64, + "description": "The name of the dashboard." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Portal/dashboards" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DashboardProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The shared dashboard properties." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties", + "location" + ], + "description": "Microsoft.Portal/dashboards" + } + }, + "definitions": { + "DashboardLens": { + "type": "object", + "properties": { + "order": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The lens order." + }, + "parts": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DashboardParts" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard parts." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard len's metadata." + } + }, + "required": [ + "order", + "parts" + ], + "description": "A dashboard lens." + }, + "DashboardParts": { + "type": "object", + "properties": { + "position": { + "oneOf": [ + { + "$ref": "#/definitions/DashboardPartsPosition" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part position." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard part's metadata." + } + }, + "required": [ + "position" + ], + "description": "A dashboard part." + }, + "DashboardPartsPosition": { + "type": "object", + "properties": { + "x": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part x coordinate." + }, + "y": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part y coordinate." + }, + "rowSpan": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part row span." + }, + "colSpan": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part column span." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard part's metadata." + } + }, + "required": [ + "x", + "y", + "rowSpan", + "colSpan" + ], + "description": "The dashboard's part position." + }, + "DashboardProperties": { + "type": "object", + "properties": { + "lenses": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DashboardLens" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard lenses." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard metadata." + } + }, + "description": "The shared dashboard properties." + } + } +} diff --git a/test/Resource/Expected/Microsoft.Portal/2019-01-01-preview/Microsoft.Portal.json b/test/Resource/Expected/Microsoft.Portal/2019-01-01-preview/Microsoft.Portal.json new file mode 100644 index 0000000..ebd1417 --- /dev/null +++ b/test/Resource/Expected/Microsoft.Portal/2019-01-01-preview/Microsoft.Portal.json @@ -0,0 +1,268 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-01-01-preview/Microsoft.Portal.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Portal", + "description": "Microsoft Portal Resource Types", + "resourceDefinitions": { + "dashboards": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 3, + "maxLength": 64, + "description": "The name of the dashboard." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Portal/dashboards" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DashboardProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The shared dashboard properties." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties", + "location" + ], + "description": "Microsoft.Portal/dashboards" + } + }, + "definitions": { + "DashboardLens": { + "type": "object", + "properties": { + "order": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The lens order." + }, + "parts": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DashboardParts" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard parts." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard len's metadata." + } + }, + "required": [ + "order", + "parts" + ], + "description": "A dashboard lens." + }, + "DashboardParts": { + "type": "object", + "properties": { + "position": { + "oneOf": [ + { + "$ref": "#/definitions/DashboardPartsPosition" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part position." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard part's metadata." + } + }, + "required": [ + "position" + ], + "description": "A dashboard part." + }, + "DashboardPartsPosition": { + "type": "object", + "properties": { + "x": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part x coordinate." + }, + "y": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part y coordinate." + }, + "rowSpan": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part row span." + }, + "colSpan": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard's part column span." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard part's metadata." + } + }, + "required": [ + "x", + "y", + "rowSpan", + "colSpan" + ], + "description": "The dashboard's part position." + }, + "DashboardProperties": { + "type": "object", + "properties": { + "lenses": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DashboardLens" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard lenses." + }, + "metadata": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": {} + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The dashboard metadata." + } + }, + "description": "The shared dashboard properties." + } + } +} diff --git a/test/Resource/Expected/Relay/2016-07-01/Microsoft.Relay.json b/test/Resource/Expected/Microsoft.Relay/2016-07-01/Microsoft.Relay.json similarity index 89% rename from test/Resource/Expected/Relay/2016-07-01/Microsoft.Relay.json rename to test/Resource/Expected/Microsoft.Relay/2016-07-01/Microsoft.Relay.json index f6ed607..8ac31a6 100644 --- a/test/Resource/Expected/Relay/2016-07-01/Microsoft.Relay.json +++ b/test/Resource/Expected/Microsoft.Relay/2016-07-01/Microsoft.Relay.json @@ -39,7 +39,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Resource tags" @@ -50,7 +50,7 @@ "$ref": "#/definitions/Sku" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Sku of the Namespace." @@ -61,10 +61,10 @@ "$ref": "#/definitions/RelayNamespaceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Description of Relay Namespace" + "description": "Properties of the Namespace." }, "resources": { "type": "array", @@ -119,10 +119,10 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Authorization Rule properties" + "description": "AuthorizationRule properties." } }, "required": [ @@ -160,10 +160,10 @@ "$ref": "#/definitions/HybridConnectionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of HybridConnection" + "description": "Properties of the HybridConnection." }, "resources": { "type": "array", @@ -211,10 +211,10 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Authorization Rule properties" + "description": "AuthorizationRule properties." } }, "required": [ @@ -252,10 +252,10 @@ "$ref": "#/definitions/WcfRelayProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of WcfRelay" + "description": "Properties of the WcfRelay Properties." }, "resources": { "type": "array", @@ -303,10 +303,10 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Authorization Rule properties" + "description": "AuthorizationRule properties." } }, "required": [ @@ -336,7 +336,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The rights associated with the rule." @@ -356,7 +356,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "true if client authorization is needed for this HybridConnection; otherwise, false." @@ -393,10 +393,10 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Authorization Rule properties" + "description": "AuthorizationRule properties." } }, "required": [ @@ -432,10 +432,10 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Authorization Rule properties" + "description": "AuthorizationRule properties." } }, "required": [ @@ -471,10 +471,10 @@ "$ref": "#/definitions/HybridConnectionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of HybridConnection" + "description": "Properties of the HybridConnection." } }, "required": [ @@ -510,10 +510,10 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Authorization Rule properties" + "description": "AuthorizationRule properties." } }, "required": [ @@ -549,10 +549,10 @@ "$ref": "#/definitions/WcfRelayProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of WcfRelay" + "description": "Properties of the WcfRelay Properties." } }, "required": [ @@ -580,7 +580,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Name of this Sku" @@ -594,7 +594,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The tier of this particular SKU" @@ -619,7 +619,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "WCFRelay Type." @@ -630,7 +630,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "true if client authorization is needed for this relay; otherwise, false." @@ -641,7 +641,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "true if transport security is needed for this relay; otherwise, false." diff --git a/test/Resource/Expected/Relay/2017-04-01/Microsoft.Relay.json b/test/Resource/Expected/Microsoft.Relay/2017-04-01/Microsoft.Relay.json similarity index 92% rename from test/Resource/Expected/Relay/2017-04-01/Microsoft.Relay.json rename to test/Resource/Expected/Microsoft.Relay/2017-04-01/Microsoft.Relay.json index 93cfb29..2229137 100644 --- a/test/Resource/Expected/Relay/2017-04-01/Microsoft.Relay.json +++ b/test/Resource/Expected/Microsoft.Relay/2017-04-01/Microsoft.Relay.json @@ -39,7 +39,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Resource tags." @@ -50,7 +50,7 @@ "$ref": "#/definitions/Sku" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "SKU of the namespace." @@ -61,10 +61,10 @@ "$ref": "#/definitions/RelayNamespaceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Description of Relay namespace" + "description": "Properties of the namespace." }, "resources": { "type": "array", @@ -118,7 +118,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Authorization rule properties." @@ -158,7 +158,7 @@ "$ref": "#/definitions/HybridConnectionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties of the HybridConnection." @@ -208,7 +208,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Authorization rule properties." @@ -248,7 +248,7 @@ "$ref": "#/definitions/WcfRelayProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties of the WCF relay." @@ -298,7 +298,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Authorization rule properties." @@ -331,7 +331,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The rights associated with the rule." @@ -351,7 +351,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Returns true if client authorization is needed for this hybrid connection; otherwise, false." @@ -388,7 +388,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Authorization rule properties." @@ -427,7 +427,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Authorization rule properties." @@ -466,7 +466,7 @@ "$ref": "#/definitions/HybridConnectionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties of the HybridConnection." @@ -505,7 +505,7 @@ "$ref": "#/definitions/AuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Authorization rule properties." @@ -544,7 +544,7 @@ "$ref": "#/definitions/WcfRelayProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties of the WCF relay." @@ -575,7 +575,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Name of this SKU." @@ -589,7 +589,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The tier of this SKU." @@ -613,7 +613,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "WCF relay type." @@ -624,7 +624,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Returns true if client authorization is needed for this relay; otherwise, false." @@ -635,7 +635,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Returns true if transport security is needed for this relay; otherwise, false." diff --git a/test/Resource/Expected/ServiceBus/2015-08-01/Microsoft.ServiceBus.json b/test/Resource/Expected/Microsoft.ServiceBus/2015-08-01/Microsoft.ServiceBus.json similarity index 88% rename from test/Resource/Expected/ServiceBus/2015-08-01/Microsoft.ServiceBus.json rename to test/Resource/Expected/Microsoft.ServiceBus/2015-08-01/Microsoft.ServiceBus.json index 8783423..d46850a 100644 --- a/test/Resource/Expected/ServiceBus/2015-08-01/Microsoft.ServiceBus.json +++ b/test/Resource/Expected/Microsoft.ServiceBus/2015-08-01/Microsoft.ServiceBus.json @@ -8,7 +8,10 @@ "type": "object", "properties": { "name": { - "type": "string" + "type": "string", + "minLength": 6, + "maxLength": 50, + "description": "The namespace name" }, "type": { "type": "string", @@ -32,9 +35,10 @@ "$ref": "#/definitions/Sku" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "SKU of the namespace." }, "tags": { "oneOf": [ @@ -46,7 +50,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Namespace tags." @@ -57,9 +61,10 @@ "$ref": "#/definitions/NamespaceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties of the namespace." }, "resources": { "type": "array", @@ -94,7 +99,7 @@ "type": "string", "minLength": 1, "maxLength": 50, - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -118,9 +123,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "SharedAccessAuthorizationRule properties." } }, "required": [ @@ -162,9 +168,10 @@ "$ref": "#/definitions/QueueProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The Queue Properties definition." }, "resources": { "type": "array", @@ -193,7 +200,7 @@ "type": "string", "minLength": 1, "maxLength": 50, - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -217,9 +224,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "SharedAccessAuthorizationRule properties." } }, "required": [ @@ -261,9 +269,10 @@ "$ref": "#/definitions/TopicProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The Topic Properties definition." }, "resources": { "type": "array", @@ -295,7 +304,7 @@ "type": "string", "minLength": 1, "maxLength": 50, - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -319,9 +328,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "SharedAccessAuthorizationRule properties." } }, "required": [ @@ -363,9 +373,10 @@ "$ref": "#/definitions/SubscriptionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Description of Subscription Resource." } }, "required": [ @@ -403,7 +414,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "State of the namespace." @@ -414,7 +425,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Indicates whether to create an ACS namespace." @@ -425,7 +436,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Specifies whether this instance is enabled." @@ -438,7 +449,7 @@ "properties": { "name": { "type": "string", - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -462,9 +473,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "SharedAccessAuthorizationRule properties." } }, "required": [ @@ -480,7 +492,7 @@ "properties": { "name": { "type": "string", - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -504,9 +516,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "SharedAccessAuthorizationRule properties." } }, "required": [ @@ -546,9 +559,10 @@ "$ref": "#/definitions/QueueProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The Queue Properties definition." } }, "required": [ @@ -565,7 +579,7 @@ "properties": { "name": { "type": "string", - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -589,9 +603,10 @@ "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "SharedAccessAuthorizationRule properties." } }, "required": [ @@ -631,9 +646,10 @@ "$ref": "#/definitions/TopicProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The Topic Properties definition." } }, "required": [ @@ -674,9 +690,10 @@ "$ref": "#/definitions/SubscriptionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Description of Subscription Resource." } }, "required": [ @@ -712,7 +729,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Entity availability status for the queue." @@ -731,7 +748,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether server-side batched operations are enabled." @@ -742,7 +759,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether this queue has dead letter support when a message expires." @@ -753,7 +770,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage." @@ -764,7 +781,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether the queue is to be partitioned across multiple message brokers." @@ -775,7 +792,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether the message is accessible anonymously." @@ -786,7 +803,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries." @@ -797,7 +814,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The maximum size of the queue in megabytes, which is the size of memory allocated for the queue." @@ -808,7 +825,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value indicating if this queue requires duplicate detection." @@ -819,7 +836,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether the queue supports the concept of sessions." @@ -841,7 +858,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Enumerates the possible values for the status of a messaging entity." @@ -852,7 +869,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether the queue supports ordering." @@ -877,7 +894,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The rights associated with the rule." @@ -902,7 +919,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Name of this SKU." @@ -918,7 +935,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The billing tier of this particular SKU." @@ -929,7 +946,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The specified messaging units for the tier." @@ -957,7 +974,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether a subscription has dead letter support on filter evaluation exceptions." @@ -968,7 +985,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether a subscription has dead letter support when a message expires." @@ -979,7 +996,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether server-side batched operations are enabled." @@ -997,7 +1014,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Entity availability status for the topic." @@ -1008,7 +1025,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether the entity description is read-only." @@ -1023,7 +1040,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Number of maximum deliveries." @@ -1034,7 +1051,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value indicating if a subscription supports the concept of sessions." @@ -1056,7 +1073,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Enumerates the possible values for the status of a messaging entity." @@ -1084,7 +1101,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Entity availability status for the topic." @@ -1103,7 +1120,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether server-side batched operations are enabled." @@ -1114,7 +1131,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage." @@ -1125,29 +1142,18 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether the topic to be partitioned across multiple message brokers is enabled." }, - "enableSubscriptionPartitioning": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Value that indicates whether partitioning is enabled or disabled. NOTE: This property is unsupported, and may be deprecated." - }, "filteringMessagesBeforePublishing": { "oneOf": [ { "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Whether messages should be filtered before publishing." @@ -1158,7 +1164,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether the message is accessible anonymously." @@ -1169,7 +1175,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ] }, @@ -1179,7 +1185,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic." @@ -1190,7 +1196,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value indicating if this topic requires duplicate detection." @@ -1212,7 +1218,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Enumerates the possible values for the status of a messaging entity." @@ -1223,13 +1229,13 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether the topic supports ordering." } }, - "description": "The Tpoic Properties definition." + "description": "The Topic Properties definition." } } } diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/Microsoft.ServiceBus.json b/test/Resource/Expected/Microsoft.ServiceBus/2017-04-01/Microsoft.ServiceBus.json similarity index 71% rename from test/Resource/Expected/ServiceBus/2017-04-01/Microsoft.ServiceBus.json rename to test/Resource/Expected/Microsoft.ServiceBus/2017-04-01/Microsoft.ServiceBus.json index 5efb45f..0f0d06b 100644 --- a/test/Resource/Expected/ServiceBus/2017-04-01/Microsoft.ServiceBus.json +++ b/test/Resource/Expected/Microsoft.ServiceBus/2017-04-01/Microsoft.ServiceBus.json @@ -8,7 +8,10 @@ "type": "object", "properties": { "name": { - "type": "string" + "type": "string", + "minLength": 6, + "maxLength": 50, + "description": "The namespace name" }, "type": { "type": "string", @@ -36,7 +39,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Resource tags" @@ -47,10 +50,10 @@ "$ref": "#/definitions/SBSku" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Porperties of Sku" + "description": "SKU of the namespace." }, "properties": { "oneOf": [ @@ -58,7 +61,7 @@ "$ref": "#/definitions/SBNamespaceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties of the namespace." @@ -70,9 +73,15 @@ { "$ref": "#/definitions/namespaces_AuthorizationRules_childResource" }, + { + "$ref": "#/definitions/namespaces_networkRuleSets_childResource" + }, { "$ref": "#/definitions/namespaces_disasterRecoveryConfigs_childResource" }, + { + "$ref": "#/definitions/namespaces_migrationConfigurations_childResource" + }, { "$ref": "#/definitions/namespaces_queues_childResource" }, @@ -99,7 +108,7 @@ "type": "string", "minLength": 1, "maxLength": 50, - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -119,7 +128,7 @@ "$ref": "#/definitions/SBAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "AuthorizationRule properties." @@ -160,7 +169,7 @@ "$ref": "#/definitions/ArmDisasterRecoveryProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" @@ -174,6 +183,101 @@ ], "description": "Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs" }, + "namespaces_migrationConfigurations": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "$default" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration name. Should always be \"$default\"." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceBus/namespaces/migrationConfigurations" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-04-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MigrationConfigPropertiesProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties required to the Create Migration Configuration" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/migrationConfigurations" + }, + "namespaces_networkRuleSets": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceBus/namespaces/networkRuleSets" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-04-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NetworkRuleSet properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/networkRuleSets" + }, "namespaces_queues": { "type": "object", "properties": { @@ -200,10 +304,10 @@ "$ref": "#/definitions/SBQueueProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Queue Properties" + "description": "The Queue Properties definition." }, "resources": { "type": "array", @@ -231,7 +335,7 @@ "type": "string", "minLength": 1, "maxLength": 50, - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -251,7 +355,7 @@ "$ref": "#/definitions/SBAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "AuthorizationRule properties." @@ -291,10 +395,10 @@ "$ref": "#/definitions/SBTopicProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of topic resource." + "description": "The Topic Properties definition." }, "resources": { "type": "array", @@ -325,7 +429,7 @@ "type": "string", "minLength": 1, "maxLength": 50, - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -345,7 +449,7 @@ "$ref": "#/definitions/SBAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "AuthorizationRule properties." @@ -386,10 +490,10 @@ "$ref": "#/definitions/SBSubscriptionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of subscriptions resource." + "description": "Description of Subscription Resource." }, "resources": { "type": "array", @@ -437,10 +541,10 @@ "$ref": "#/definitions/Ruleproperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of Rule resource" + "description": "Description of Rule Resource." } }, "required": [ @@ -466,7 +570,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." @@ -478,7 +582,7 @@ "default": true }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether the rule action requires preprocessing." @@ -491,11 +595,11 @@ "properties": { "partnerNamespace": { "type": "string", - "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairning" + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" }, "alternateName": { "type": "string", - "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairning" + "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" } }, "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" @@ -503,6 +607,21 @@ "CorrelationFilter": { "type": "object", "properties": { + "properties": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "dictionary object for custom filters" + }, "correlationId": { "type": "string", "description": "Identifier of the correlation." @@ -542,7 +661,7 @@ "default": true }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether the rule action requires preprocessing." @@ -550,12 +669,30 @@ }, "description": "Represents the correlation filter expression." }, + "MigrationConfigPropertiesProperties": { + "type": "object", + "properties": { + "targetNamespace": { + "type": "string", + "description": "Existing premium Namespace ARM Id name which has no entities, will be used for migration" + }, + "postMigrationName": { + "type": "string", + "description": "Name to access Standard Namespace after migration" + } + }, + "required": [ + "targetNamespace", + "postMigrationName" + ], + "description": "Properties required to the Create Migration Configuration" + }, "namespaces_AuthorizationRules_childResource": { "type": "object", "properties": { "name": { "type": "string", - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -575,7 +712,7 @@ "$ref": "#/definitions/SBAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "AuthorizationRule properties." @@ -614,7 +751,7 @@ "$ref": "#/definitions/ArmDisasterRecoveryProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" @@ -628,12 +765,107 @@ ], "description": "Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs" }, + "namespaces_migrationConfigurations_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "$default" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration name. Should always be \"$default\"." + }, + "type": { + "type": "string", + "enum": [ + "migrationConfigurations" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-04-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/MigrationConfigPropertiesProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties required to the Create Migration Configuration" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/migrationConfigurations" + }, + "namespaces_networkRuleSets_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "networkRuleSets" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-04-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NetworkRuleSet properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/networkRuleSets" + }, "namespaces_queues_authorizationRules_childResource": { "type": "object", "properties": { "name": { "type": "string", - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -653,7 +885,7 @@ "$ref": "#/definitions/SBAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "AuthorizationRule properties." @@ -692,10 +924,10 @@ "$ref": "#/definitions/SBQueueProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Queue Properties" + "description": "The Queue Properties definition." } }, "required": [ @@ -711,7 +943,7 @@ "properties": { "name": { "type": "string", - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "type": { "type": "string", @@ -731,7 +963,7 @@ "$ref": "#/definitions/SBAuthorizationRuleProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "AuthorizationRule properties." @@ -770,10 +1002,10 @@ "$ref": "#/definitions/SBTopicProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of topic resource." + "description": "The Topic Properties definition." } }, "required": [ @@ -809,10 +1041,10 @@ "$ref": "#/definitions/SBSubscriptionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of subscriptions resource." + "description": "Description of Subscription Resource." } }, "required": [ @@ -848,10 +1080,10 @@ "$ref": "#/definitions/Ruleproperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of Rule resource" + "description": "Description of Rule Resource." } }, "required": [ @@ -862,6 +1094,107 @@ ], "description": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules" }, + "NetworkRuleSetProperties": { + "type": "object", + "properties": { + "defaultAction": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Allow", + "Deny" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Default Action for Network Rule Set." + }, + "virtualNetworkRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of IpRules" + } + }, + "description": "NetworkRuleSet properties" + }, + "NWRuleSetIpRules": { + "type": "object", + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Allow" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The IP Filter Action." + } + }, + "description": "Description of NetWorkRuleSet - IpRules resource." + }, + "NWRuleSetVirtualNetworkRules": { + "type": "object", + "properties": { + "subnet": { + "oneOf": [ + { + "$ref": "#/definitions/Subnet" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied for Subnet" + }, + "ignoreMissingVnetServiceEndpoint": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value that indicates whether to ignore missing VNet Service Endpoint" + } + }, + "description": "Description of VirtualNetworkRules - NetworkRules resource." + }, "Ruleproperties": { "type": "object", "properties": { @@ -871,7 +1204,7 @@ "$ref": "#/definitions/Action" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." @@ -886,7 +1219,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Filter type that is evaluated against a BrokeredMessage." @@ -897,10 +1230,10 @@ "$ref": "#/definitions/SqlFilter" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of sqlFilter" + "description": "Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline." }, "correlationFilter": { "oneOf": [ @@ -908,10 +1241,10 @@ "$ref": "#/definitions/CorrelationFilter" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Properties of correlationFilter" + "description": "Represents the correlation filter expression." } }, "description": "Description of Rule Resource." @@ -933,7 +1266,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The rights associated with the rule." @@ -963,7 +1296,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024." @@ -974,7 +1307,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value indicating if this queue requires duplicate detection." @@ -985,7 +1318,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether the queue supports the concept of sessions." @@ -1001,7 +1334,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether this queue has dead letter support when a message expires." @@ -1017,7 +1350,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10." @@ -1039,11 +1372,22 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Enumerates the possible values for the status of a messaging entity." }, + "enableBatchedOperations": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value that indicates whether server-side batched operations are enabled." + }, "autoDeleteOnIdle": { "type": "string", "format": "duration", @@ -1055,7 +1399,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether the queue is to be partitioned across multiple message brokers." @@ -1066,7 +1410,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage." @@ -1096,7 +1440,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Name of this SKU." @@ -1112,7 +1456,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The billing tier of this particular SKU." @@ -1123,7 +1467,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4." @@ -1148,7 +1492,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value indicating if a subscription supports the concept of sessions." @@ -1158,13 +1502,24 @@ "format": "duration", "description": "ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." }, + "deadLetteringOnFilterEvaluationExceptions": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value that indicates whether a subscription has dead letter support on filter evaluation exceptions." + }, "deadLetteringOnMessageExpiration": { "oneOf": [ { "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether a subscription has dead letter support when a message expires." @@ -1180,7 +1535,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Number of maximum deliveries." @@ -1202,7 +1557,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Enumerates the possible values for the status of a messaging entity." @@ -1213,7 +1568,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether server-side batched operations are enabled." @@ -1248,7 +1603,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024." @@ -1259,7 +1614,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value indicating if this topic requires duplicate detection." @@ -1275,7 +1630,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether server-side batched operations are enabled." @@ -1297,7 +1652,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Enumerates the possible values for the status of a messaging entity." @@ -1308,7 +1663,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether the topic supports ordering." @@ -1324,7 +1679,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether the topic to be partitioned across multiple message brokers is enabled." @@ -1335,13 +1690,13 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage." } }, - "description": "The Tpoic Properties definition." + "description": "The Topic Properties definition." }, "SqlFilter": { "type": "object", @@ -1350,6 +1705,20 @@ "type": "string", "description": "The SQL expression. e.g. MyProperty='ABC'" }, + "compatibilityLevel": { + "oneOf": [ + { + "type": "integer", + "minimum": 20, + "maximum": 20, + "default": "20" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, "requiresPreprocessing": { "oneOf": [ { @@ -1357,13 +1726,26 @@ "default": true }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Value that indicates whether the rule action requires preprocessing." } }, "description": "Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline." + }, + "Subnet": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "required": [ + "id" + ], + "description": "Properties supplied for Subnet" } } } diff --git a/test/Resource/Expected/Microsoft.ServiceBus/2018-01-01-preview/Microsoft.ServiceBus.json b/test/Resource/Expected/Microsoft.ServiceBus/2018-01-01-preview/Microsoft.ServiceBus.json new file mode 100644 index 0000000..9702c8b --- /dev/null +++ b/test/Resource/Expected/Microsoft.ServiceBus/2018-01-01-preview/Microsoft.ServiceBus.json @@ -0,0 +1,567 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-01-01-preview/Microsoft.ServiceBus.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.ServiceBus", + "description": "Microsoft ServiceBus Resource Types", + "resourceDefinitions": { + "namespaces": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 6, + "maxLength": 50, + "description": "The namespace name" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceBus/namespaces" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "location": { + "type": "string", + "description": "The Geo-location where the resource lives" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/SBSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SKU of the namespace." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SBNamespaceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the namespace." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/namespaces_ipfilterrules_childResource" + }, + { + "$ref": "#/definitions/namespaces_virtualnetworkrules_childResource" + }, + { + "$ref": "#/definitions/namespaces_networkrulesets_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces" + }, + "namespaces_ipfilterrules": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The IP Filter Rule name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceBus/namespaces/ipfilterrules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IpFilterRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update IpFilterRules" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/ipfilterrules" + }, + "namespaces_networkrulesets": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceBus/namespaces/networkrulesets" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NetworkRuleSet properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/networkrulesets" + }, + "namespaces_virtualnetworkrules": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "description": "The Virtual Network Rule name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceBus/namespaces/virtualnetworkrules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualNetworkRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update VirtualNetworkRules" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/virtualnetworkrules" + } + }, + "definitions": { + "IpFilterRuleProperties": { + "type": "object", + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Accept", + "Reject" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The IP Filter Action." + }, + "filterName": { + "type": "string", + "description": "IP Filter name" + } + }, + "description": "Properties supplied to create or update IpFilterRules" + }, + "namespaces_ipfilterrules_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The IP Filter Rule name." + }, + "type": { + "type": "string", + "enum": [ + "ipfilterrules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/IpFilterRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update IpFilterRules" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/ipfilterrules" + }, + "namespaces_networkrulesets_childResource": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "pattern": "^.*/default$" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "networkrulesets" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "NetworkRuleSet properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/networkrulesets" + }, + "namespaces_virtualnetworkrules_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Virtual Network Rule name." + }, + "type": { + "type": "string", + "enum": [ + "virtualnetworkrules" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-01-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualNetworkRuleProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied to create or update VirtualNetworkRules" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceBus/namespaces/virtualnetworkrules" + }, + "NetworkRuleSetProperties": { + "type": "object", + "properties": { + "defaultAction": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Allow", + "Deny" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Default Action for Network Rule Set." + }, + "virtualNetworkRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of IpRules" + } + }, + "description": "NetworkRuleSet properties" + }, + "NWRuleSetIpRules": { + "type": "object", + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Allow" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The IP Filter Action." + } + }, + "description": "The response from the List namespace operation." + }, + "NWRuleSetVirtualNetworkRules": { + "type": "object", + "properties": { + "subnet": { + "oneOf": [ + { + "$ref": "#/definitions/Subnet" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties supplied for Subnet" + }, + "ignoreMissingVnetServiceEndpoint": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" + } + }, + "description": "The response from the List namespace operation." + }, + "SBNamespaceProperties": { + "type": "object", + "properties": { + "zoneRedundant": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones." + } + }, + "description": "Properties of the namespace." + }, + "SBSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic", + "Standard", + "Premium" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Name of this SKU." + }, + "tier": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic", + "Standard", + "Premium" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The billing tier of this particular SKU." + }, + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4." + } + }, + "required": [ + "name" + ], + "description": "SKU of the namespace." + }, + "Subnet": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied for Subnet" + }, + "VirtualNetworkRuleProperties": { + "type": "object", + "properties": { + "virtualNetworkSubnetId": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied to create or update VirtualNetworkRules" + } + } +} diff --git a/test/Resource/Expected/ServiceFabric/2016-09-01/Microsoft.ServiceFabric.json b/test/Resource/Expected/Microsoft.ServiceFabric/2016-09-01/Microsoft.ServiceFabric.json similarity index 87% rename from test/Resource/Expected/ServiceFabric/2016-09-01/Microsoft.ServiceFabric.json rename to test/Resource/Expected/Microsoft.ServiceFabric/2016-09-01/Microsoft.ServiceFabric.json index 240b2df..c4aefb7 100644 --- a/test/Resource/Expected/ServiceFabric/2016-09-01/Microsoft.ServiceFabric.json +++ b/test/Resource/Expected/Microsoft.ServiceFabric/2016-09-01/Microsoft.ServiceFabric.json @@ -37,7 +37,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Resource tags." @@ -48,9 +48,10 @@ "$ref": "#/definitions/ClusterProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The cluster resource properties" } }, "required": [ @@ -109,7 +110,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The local certificate store location." @@ -129,14 +130,14 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Is this certificate used for admin access from the client, if false , it is used or query only access" }, "certificateCommonName": { "type": "string", - "description": "Certificate common name to be granted access; be carefull using wild card common names" + "description": "Certificate common name to be granted access; be careful using wild card common names" }, "certificateIssuerThumbprint": { "type": "string", @@ -159,7 +160,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Is this certificate used for admin access from the client, if false, it is used or query only access" @@ -186,7 +187,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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. " @@ -199,7 +200,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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. " @@ -220,10 +221,10 @@ "$ref": "#/definitions/CertificateDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "This primay certificate will be used as cluster node to node security, SSL certificate for cluster management endpoint and default admin client" + "description": "Certificate details" }, "reliabilityLevel": { "oneOf": [ @@ -237,7 +238,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Cluster reliability level indicates replica set size of system service." @@ -252,7 +253,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not." @@ -266,7 +267,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The client thumbprint details ,it is used for client access for cluster operation" @@ -280,7 +281,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": " List of client certificates to whitelist based on common names" @@ -294,7 +295,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "List of custom fabric settings to configure the cluster." @@ -305,10 +306,10 @@ "$ref": "#/definitions/CertificateDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The server certificate used by reverse proxy" + "description": "Certificate details" }, "managementEndpoint": { "type": "string", @@ -323,10 +324,10 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The list of nodetypes that make up the cluster" + "description": "The list of node types that make up the cluster" }, "azureActiveDirectory": { "oneOf": [ @@ -334,7 +335,7 @@ "$ref": "#/definitions/AzureActiveDirectory" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The settings to enable AAD authentication on the cluster" @@ -349,10 +350,10 @@ "$ref": "#/definitions/DiagnosticsStorageAccountConfig" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The storage diagnostics account configuration details" + "description": "Diagnostics storage account config" }, "upgradeDescription": { "oneOf": [ @@ -360,10 +361,10 @@ "$ref": "#/definitions/ClusterUpgradePolicy" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The policy to use when upgrading the cluster." + "description": "Cluster upgrade policy" } }, "required": [ @@ -383,7 +384,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Additional unhealthy nodes percentage" @@ -396,7 +397,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Additional unhealthy nodes percentage per upgrade domain " @@ -409,7 +410,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Additional unhealthy applications percentage" @@ -431,7 +432,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Use the user defined upgrade policy or not" @@ -442,7 +443,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Force node to restart or not" @@ -477,10 +478,10 @@ "$ref": "#/definitions/ClusterHealthPolicy" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Cluster health Policy" + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." }, "deltaHealthPolicy": { "oneOf": [ @@ -488,10 +489,10 @@ "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Delta health policy" + "description": "Delta health policy for the cluster" } }, "required": [ @@ -547,7 +548,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Starting port of a range of ports" @@ -558,7 +559,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "End port of a range of ports" @@ -587,7 +588,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run" @@ -602,7 +603,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much of a resource a node has" @@ -613,7 +614,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The TCP cluster management endpoint port" @@ -624,7 +625,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The HTTP cluster management endpoint port" @@ -640,10 +641,10 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Nodetype durability Level." + "description": "Node type durability Level." }, "applicationPorts": { "oneOf": [ @@ -651,10 +652,10 @@ "$ref": "#/definitions/EndpointRangeDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Ports used by applications" + "description": "Port range details" }, "ephemeralPorts": { "oneOf": [ @@ -662,10 +663,10 @@ "$ref": "#/definitions/EndpointRangeDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "System assgined application ports" + "description": "Port range details" }, "isPrimary": { "oneOf": [ @@ -673,7 +674,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Mark this as the primary node type" @@ -686,7 +687,7 @@ "maximum": 2147483647 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The number of node instances in the node type" @@ -697,7 +698,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Endpoint used by reverse proxy" @@ -746,7 +747,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Collection of settings in the section, each setting is a tuple consisting of setting name and value" diff --git a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/Microsoft.ServiceFabric.json b/test/Resource/Expected/Microsoft.ServiceFabric/2017-07-01-preview/Microsoft.ServiceFabric.json similarity index 77% rename from test/Resource/Expected/ServiceFabric/2017-07-01-preview/Microsoft.ServiceFabric.json rename to test/Resource/Expected/Microsoft.ServiceFabric/2017-07-01-preview/Microsoft.ServiceFabric.json index 98843f0..5f7b453 100644 --- a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/Microsoft.ServiceFabric.json +++ b/test/Resource/Expected/Microsoft.ServiceFabric/2017-07-01-preview/Microsoft.ServiceFabric.json @@ -9,7 +9,7 @@ "properties": { "name": { "type": "string", - "description": "The name of the cluster resource" + "description": "The name of the cluster resource." }, "type": { "type": "string", @@ -37,7 +37,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Resource tags." @@ -48,10 +48,10 @@ "$ref": "#/definitions/ClusterProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The cluster resource properties" + "description": "Describes the cluster resource properties." }, "resources": { "type": "array", @@ -97,17 +97,18 @@ }, "location": { "type": "string", - "description": "Resource location." + "description": "Azure resource location." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/ApplicationProperties" + "$ref": "#/definitions/ApplicationResourceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The application resource properties." }, "resources": { "type": "array", @@ -124,7 +125,6 @@ "name", "type", "apiVersion", - "location", "properties" ], "description": "Microsoft.ServiceFabric/clusters/applications" @@ -150,24 +150,24 @@ }, "location": { "type": "string", - "description": "Resource location." + "description": "Azure resource location." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/ServiceProperties" + "$ref": "#/definitions/ServiceResourceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The service resource properties." } }, "required": [ "name", "type", "apiVersion", - "location", "properties" ], "description": "Microsoft.ServiceFabric/clusters/applications/services" @@ -177,7 +177,7 @@ "properties": { "name": { "type": "string", - "description": "The name of the application type name resource" + "description": "The name of the application type name resource." }, "type": { "type": "string", @@ -193,17 +193,18 @@ }, "location": { "type": "string", - "description": "Resource location." + "description": "Azure resource location." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/ApplicationTypeProperties" + "$ref": "#/definitions/ApplicationTypeResourceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The application type name properties" }, "resources": { "type": "array", @@ -220,7 +221,6 @@ "name", "type", "apiVersion", - "location", "properties" ], "description": "Microsoft.ServiceFabric/clusters/applicationTypes" @@ -246,83 +246,30 @@ }, "location": { "type": "string", - "description": "Resource location." + "description": "Azure resource location." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/VersionProperties" + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The properties of the application type version resource." } }, "required": [ "name", "type", "apiVersion", - "location", "properties" ], "description": "Microsoft.ServiceFabric/clusters/applicationTypes/versions" } }, "definitions": { - "ApplicationHealthPolicy": { - "type": "object", - "properties": { - "ConsiderWarningAsError": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether warnings are treated with the same severity as errors." - }, - "MaxPercentUnhealthyDeployedApplications": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n" - }, - "DefaultServiceTypeHealthPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/ServiceTypeHealthPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "ServiceTypeHealthPolicyMap": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTypeHealthPolicyMapItem" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" - }, "ApplicationMetricDescription": { "type": "object", "properties": { @@ -336,7 +283,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The maximum node capacity for Service Fabric application.\nThis 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.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\n" @@ -347,7 +294,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.\n" @@ -358,7 +305,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The total metric capacity for Service Fabric application.\nThis 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.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.\n" @@ -366,42 +313,27 @@ }, "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.\n" }, - "ApplicationParameter": { - "type": "object", - "properties": { - "Key": { - "type": "string", - "description": "The name of the parameter." - }, - "Value": { - "type": "string", - "description": "The value of the parameter." - } - }, - "required": [ - "Key", - "Value" - ], - "description": "Describes an application parameter override to be applied when creating or upgrading an application." - }, - "ApplicationProperties": { + "ApplicationResourceProperties": { "type": "object", "properties": { "typeVersion": { - "type": "string" + "type": "string", + "description": "The version of the application type as defined in the application manifest." }, "parameters": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationParameter" - } + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "List of application parameters with overridden values from their default values specified in the application manifest." }, "upgradePolicy": { "oneOf": [ @@ -409,9 +341,10 @@ "$ref": "#/definitions/ApplicationUpgradePolicy" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the policy for a monitored application upgrade." }, "minimumNodes": { "oneOf": [ @@ -420,7 +353,7 @@ "minimum": 0 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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." @@ -433,7 +366,7 @@ "default": "0" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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." @@ -444,10 +377,10 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The version of the application type" + "description": "Remove the current application capacity settings." }, "metrics": { "oneOf": [ @@ -458,67 +391,230 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "List of application capacity metric description." }, "typeName": { - "type": "string" + "type": "string", + "description": "The application type name as defined in the application manifest." } }, "description": "The application resource properties." }, - "ApplicationTypeProperties": { + "ApplicationTypeResourceProperties": { "type": "object", "properties": {}, "description": "The application type name properties" }, + "ApplicationTypeVersionResourceProperties": { + "type": "object", + "properties": { + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + } + }, + "required": [ + "appPackageUrl" + ], + "description": "The properties of the application type version resource." + }, "ApplicationUpgradePolicy": { "type": "object", "properties": { "upgradeReplicaSetCheckTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] + "type": "string", + "description": "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)." }, "forceRestart": { "oneOf": [ { - "type": "boolean" + "type": "boolean", + "default": false }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "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": { "oneOf": [ { - "$ref": "#/definitions/RollingUpgradeMonitoringPolicy" + "$ref": "#/definitions/ArmRollingUpgradeMonitoringPolicy" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The policy used for monitoring the application upgrade" }, "applicationHealthPolicy": { "oneOf": [ { - "$ref": "#/definitions/ApplicationHealthPolicy" + "$ref": "#/definitions/ArmApplicationHealthPolicy" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" } }, "description": "Describes the policy for a monitored application upgrade." }, + "ArmApplicationHealthPolicy": { + "type": "object", + "properties": { + "ConsiderWarningAsError": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether warnings are treated with the same severity as errors." + }, + "MaxPercentUnhealthyDeployedApplications": { + "oneOf": [ + { + "type": "integer", + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n" + }, + "DefaultServiceTypeHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ArmServiceTypeHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "ServiceTypeHealthPolicyMap": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ArmServiceTypeHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor 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.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n" + } + }, + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + }, + "ArmRollingUpgradeMonitoringPolicy": { + "type": "object", + "properties": { + "failureAction": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Rollback", + "Manual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The activation Mode of the service package." + }, + "healthCheckWaitDuration": { + "type": "string", + "default": "0", + "description": "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." + }, + "healthCheckStableDuration": { + "type": "string", + "default": "PT0H2M0S", + "description": "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." + }, + "healthCheckRetryTimeout": { + "type": "string", + "default": "PT0H10M0S", + "description": "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." + }, + "upgradeTimeout": { + "type": "string", + "default": "P10675199DT02H48M05.4775807S", + "description": "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." + }, + "upgradeDomainTimeout": { + "type": "string", + "default": "P10675199DT02H48M05.4775807S", + "description": "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." + } + }, + "description": "The policy used for monitoring the application upgrade" + }, + "ArmServiceTypeHealthPolicy": { + "type": "object", + "properties": { + "maxPercentUnhealthyServices": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n" + }, + "maxPercentUnhealthyPartitionsPerService": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error.\n" + }, + "maxPercentUnhealthyReplicasPerPartition": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error.\n" + } + }, + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, "AzureActiveDirectory": { "type": "object", "properties": { @@ -564,7 +660,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The local certificate store location." @@ -584,7 +680,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." @@ -614,7 +710,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." @@ -641,7 +737,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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. " @@ -654,7 +750,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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. " @@ -674,7 +770,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The Service Fabric runtime versions available for this cluster." @@ -697,7 +793,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ] }, @@ -711,10 +807,10 @@ "$ref": "#/definitions/CertificateDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client." + "description": "Describes the certificate details." }, "reliabilityLevel": { "oneOf": [ @@ -729,7 +825,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ] }, @@ -743,7 +839,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ] }, @@ -756,7 +852,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster." @@ -770,7 +866,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The list of client certificates referenced by common name that are allowed to manage the cluster." @@ -784,7 +880,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The list of custom fabric settings to configure the cluster." @@ -795,10 +891,10 @@ "$ref": "#/definitions/CertificateDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The server certificate used by reverse proxy." + "description": "Describes the certificate details." }, "managementEndpoint": { "type": "string", @@ -813,7 +909,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The list of node types in the cluster." @@ -824,10 +920,10 @@ "$ref": "#/definitions/AzureActiveDirectory" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The AAD authentication settings of the cluster." + "description": "The settings to enable AAD authentication on the cluster." }, "vmImage": { "type": "string", @@ -839,7 +935,7 @@ "$ref": "#/definitions/DiagnosticsStorageAccountConfig" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The storage account information for storing Service Fabric diagnostic logs." @@ -850,10 +946,10 @@ "$ref": "#/definitions/ClusterUpgradePolicy" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The policy to use when upgrading the cluster." + "description": "Describes the policy used when upgrading the cluster." }, "addOnFeatures": { "oneOf": [ @@ -869,7 +965,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The list of add-on features to enable in the cluster." @@ -902,24 +998,24 @@ }, "location": { "type": "string", - "description": "Resource location." + "description": "Azure resource location." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/ApplicationProperties" + "$ref": "#/definitions/ApplicationResourceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The application resource properties." } }, "required": [ "name", "type", "apiVersion", - "location", "properties" ], "description": "Microsoft.ServiceFabric/clusters/applications" @@ -945,24 +1041,24 @@ }, "location": { "type": "string", - "description": "Resource location." + "description": "Azure resource location." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/ServiceProperties" + "$ref": "#/definitions/ServiceResourceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The service resource properties." } }, "required": [ "name", "type", "apiVersion", - "location", "properties" ], "description": "Microsoft.ServiceFabric/clusters/applications/services" @@ -972,7 +1068,7 @@ "properties": { "name": { "type": "string", - "description": "The name of the application type name resource" + "description": "The name of the application type name resource." }, "type": { "type": "string", @@ -988,24 +1084,24 @@ }, "location": { "type": "string", - "description": "Resource location." + "description": "Azure resource location." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/ApplicationTypeProperties" + "$ref": "#/definitions/ApplicationTypeResourceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The application type name properties" } }, "required": [ "name", "type", "apiVersion", - "location", "properties" ], "description": "Microsoft.ServiceFabric/clusters/applicationTypes" @@ -1031,24 +1127,24 @@ }, "location": { "type": "string", - "description": "Resource location." + "description": "Azure resource location." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/VersionProperties" + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The properties of the application type version resource." } }, "required": [ "name", "type", "apiVersion", - "location", "properties" ], "description": "Microsoft.ServiceFabric/clusters/applicationTypes/versions" @@ -1064,7 +1160,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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." @@ -1077,7 +1173,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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. " @@ -1090,7 +1186,7 @@ "maximum": 100 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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." @@ -1112,14 +1208,14 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." }, "upgradeReplicaSetCheckTimeout": { "type": "string", - "description": "The maximum amount of time to block processing of an upgrade domain and revent 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." + "description": "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." }, "healthCheckWaitDuration": { "type": "string", @@ -1147,10 +1243,10 @@ "$ref": "#/definitions/ClusterHealthPolicy" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The cluster health policy used when upgrading the cluster." + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." }, "deltaHealthPolicy": { "oneOf": [ @@ -1158,10 +1254,10 @@ "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The delta health policy used when upgrading the cluster." + "description": "Describes the delta health policies for the cluster upgrade." } }, "required": [ @@ -1196,7 +1292,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Indicates if this version is for Windows or Linux operating system." @@ -1246,7 +1342,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Starting port of a range of ports" @@ -1257,7 +1353,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "End port of a range of ports" @@ -1269,48 +1365,6 @@ ], "description": "Port range details" }, - "NamedPartitionSchemeDescription": { - "type": "object", - "properties": { - "Count": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of partitions." - }, - "Names": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." - }, - "PartitionScheme": { - "type": "string", - "enum": [ - "Named" - ] - } - }, - "required": [ - "Count", - "Names", - "PartitionScheme" - ], - "description": "Describes the named partition scheme of the service." - }, "NodeTypeDescription": { "type": "object", "properties": { @@ -1328,7 +1382,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run." @@ -1343,7 +1397,7 @@ "properties": {} }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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." @@ -1354,7 +1408,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The TCP cluster management endpoint port." @@ -1365,7 +1419,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The HTTP cluster management endpoint port." @@ -1381,7 +1435,7 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ] }, @@ -1391,10 +1445,10 @@ "$ref": "#/definitions/EndpointRangeDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The range of ports from which cluster assigned port to Service Fabric applications." + "description": "Port range details" }, "ephemeralPorts": { "oneOf": [ @@ -1402,10 +1456,10 @@ "$ref": "#/definitions/EndpointRangeDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The range of empheral ports that nodes in this node type should be configured with." + "description": "Port range details" }, "isPrimary": { "oneOf": [ @@ -1413,7 +1467,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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." @@ -1426,7 +1480,7 @@ "maximum": 2147483647 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource." @@ -1437,7 +1491,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The endpoint used by reverse proxy." @@ -1454,41 +1508,9 @@ }, "PartitionSchemeDescription": { "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/NamedPartitionSchemeDescription" - }, - { - "$ref": "#/definitions/SingletonPartitionSchemeDescription" - }, - { - "$ref": "#/definitions/UniformInt64RangePartitionSchemeDescription" - } - ], "properties": {}, "description": "Describes how the service is partitioned." }, - "RollingUpgradeMonitoringPolicy": { - "type": "object", - "properties": { - "healthCheckWaitDuration": { - "type": "string" - }, - "healthCheckStableDuration": { - "type": "string" - }, - "healthCheckRetryTimeout": { - "type": "string" - }, - "upgradeTimeout": { - "type": "string" - }, - "upgradeDomainTimeout": { - "type": "string" - } - }, - "description": "The policy used for monitoring the application upgrade" - }, "ServiceCorrelationDescription": { "type": "object", "properties": { @@ -1504,12 +1526,14 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." }, "ServiceName": { - "type": "string" + "type": "string", + "description": "The full name of the service with 'fabric:' URI scheme." } }, "required": [ @@ -1537,9 +1561,10 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." }, "PrimaryDefaultLoad": { "oneOf": [ @@ -1547,7 +1572,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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." @@ -1558,7 +1583,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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." @@ -1569,7 +1594,7 @@ "type": "integer" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." @@ -1585,14 +1610,14 @@ "properties": {}, "description": "Describes the policy to be used for placement of a Service Fabric service." }, - "ServiceProperties": { + "ServiceResourceProperties": { "type": "object", "oneOf": [ { - "$ref": "#/definitions/StatelessServiceProperties" + "$ref": "#/definitions/StatefulServiceProperties" }, { - "$ref": "#/definitions/StatefulServiceProperties" + "$ref": "#/definitions/StatelessServiceProperties" } ], "properties": { @@ -1609,9 +1634,10 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "A list that describes the correlation of the service with other services." }, "serviceLoadMetrics": { "oneOf": [ @@ -1622,9 +1648,10 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." }, "servicePlacementPolicies": { "oneOf": [ @@ -1635,9 +1662,10 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "A list that describes the correlation of the service with other services." }, "defaultMoveCost": { "oneOf": [ @@ -1651,9 +1679,10 @@ ] }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Specifies the move cost for the service." }, "serviceTypeName": { "type": "string", @@ -1665,79 +1694,14 @@ "$ref": "#/definitions/PartitionSchemeDescription" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes how the service is partitioned." } }, "description": "The service resource properties." }, - "ServiceTypeHealthPolicy": { - "type": "object", - "properties": { - "MaxPercentUnhealthyPartitionsPerService": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.\n" - }, - "MaxPercentUnhealthyReplicasPerPartition": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.\n" - }, - "MaxPercentUnhealthyServices": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.\n" - } - }, - "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" - }, - "ServiceTypeHealthPolicyMapItem": { - "type": "object", - "properties": { - "Key": { - "type": "string", - "description": "The key of the service type health policy map item. This is the name of the service type." - }, - "Value": { - "oneOf": [ - { - "$ref": "#/definitions/ServiceTypeHealthPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "Key", - "Value" - ], - "description": "Defines an item in ServiceTypeHealthPolicyMap.\n" - }, "SettingsParameterDescription": { "type": "object", "properties": { @@ -1772,7 +1736,7 @@ } }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The collection of parameters in the section." @@ -1784,21 +1748,6 @@ ], "description": "Describes a section in the fabric settings of the cluster." }, - "SingletonPartitionSchemeDescription": { - "type": "object", - "properties": { - "PartitionScheme": { - "type": "string", - "enum": [ - "Singleton" - ] - } - }, - "required": [ - "PartitionScheme" - ], - "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service." - }, "StatefulServiceProperties": { "type": "object", "properties": { @@ -1808,7 +1757,7 @@ "type": "boolean" }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "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." @@ -1820,7 +1769,7 @@ "minimum": 1 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The target replica set size as a number." @@ -1832,7 +1781,7 @@ "minimum": 1 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The minimum replica set size as a number." @@ -1874,7 +1823,7 @@ "minimum": -1 }, { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], "description": "The instance count." @@ -1890,56 +1839,6 @@ "serviceKind" ], "description": "The properties of a stateless service resource." - }, - "UniformInt64RangePartitionSchemeDescription": { - "type": "object", - "properties": { - "Count": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of partitions." - }, - "LowKey": { - "type": "string", - "description": "String indicating the lower bound of the partition key range that\nshould be split between the partition ‘Count’\n" - }, - "HighKey": { - "type": "string", - "description": "String indicating the upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" - }, - "PartitionScheme": { - "type": "string", - "enum": [ - "UniformInt64Range" - ] - } - }, - "required": [ - "Count", - "LowKey", - "HighKey", - "PartitionScheme" - ], - "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions." - }, - "VersionProperties": { - "type": "object", - "properties": { - "appPackageUrl": { - "type": "string", - "description": "The URL to the application package" - } - }, - "required": [ - "appPackageUrl" - ], - "description": "The properties of the version resource." } } } diff --git a/test/Resource/Expected/Microsoft.ServiceFabric/2018-02-01/Microsoft.ServiceFabric.json b/test/Resource/Expected/Microsoft.ServiceFabric/2018-02-01/Microsoft.ServiceFabric.json new file mode 100644 index 0000000..f0c2616 --- /dev/null +++ b/test/Resource/Expected/Microsoft.ServiceFabric/2018-02-01/Microsoft.ServiceFabric.json @@ -0,0 +1,990 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-02-01/Microsoft.ServiceFabric.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.ServiceFabric", + "description": "Microsoft ServiceFabric Resource Types", + "resourceDefinitions": { + "clusters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the cluster resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-02-01" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the cluster resource properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters" + } + }, + "definitions": { + "ApplicationDeltaHealthPolicy": { + "type": "object", + "properties": { + "defaultServiceTypeDeltaHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n" + }, + "serviceTypeDeltaHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a map that contains specific delta health policies for different service types.\nEach entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.\nThe map is empty by default.\n" + } + }, + "description": "Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.\n" + }, + "ApplicationHealthPolicy": { + "type": "object", + "properties": { + "defaultServiceTypeHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "serviceTypeHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor 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.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n" + } + }, + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + }, + "AzureActiveDirectory": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "CertificateDescription": { + "type": "object", + "properties": { + "thumbprint": { + "type": "string", + "description": "Thumbprint of the primary certificate." + }, + "thumbprintSecondary": { + "type": "string", + "description": "Thumbprint of the secondary certificate." + }, + "x509StoreName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The local certificate store location." + } + }, + "required": [ + "thumbprint" + ], + "description": "Describes the certificate details." + }, + "ClientCertificateCommonName": { + "type": "object", + "properties": { + "isAdmin": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateCommonName": { + "type": "string", + "description": "The common name of the client certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the client certificate." + } + }, + "required": [ + "isAdmin", + "certificateCommonName", + "certificateIssuerThumbprint" + ], + "description": "Describes the client certificate details using common name." + }, + "ClientCertificateThumbprint": { + "type": "object", + "properties": { + "isAdmin": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateThumbprint": { + "type": "string", + "description": "The thumbprint of the client certificate." + } + }, + "required": [ + "isAdmin", + "certificateThumbprint" + ], + "description": "Describes the client certificate details using thumbprint." + }, + "ClusterHealthPolicy": { + "type": "object", + "properties": { + "maxPercentUnhealthyNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.\n" + }, + "maxPercentUnhealthyApplications": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.\n" + }, + "applicationHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ApplicationHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n" + } + }, + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n" + }, + "ClusterProperties": { + "type": "object", + "properties": { + "addOnFeatures": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of add-on features to enable in the cluster." + }, + "azureActiveDirectory": { + "oneOf": [ + { + "$ref": "#/definitions/AzureActiveDirectory" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The settings to enable AAD authentication on the cluster." + }, + "certificate": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the certificate details." + }, + "certificateCommonNames": { + "oneOf": [ + { + "$ref": "#/definitions/ServerCertificateCommonNames" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "clientCertificateCommonNames": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificateCommonName" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of client certificates referenced by common name that are allowed to manage the cluster." + }, + "clientCertificateThumbprints": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificateThumbprint" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster." + }, + "clusterCodeVersion": { + "type": "string", + "description": "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**." + }, + "diagnosticsStorageAccountConfig": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsStorageAccountConfig" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "fabricSettings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of custom fabric settings to configure the cluster." + }, + "managementEndpoint": { + "type": "string", + "description": "The http management endpoint of the cluster." + }, + "nodeTypes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NodeTypeDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of node types in the cluster." + }, + "reliabilityLevel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "Bronze", + "Silver", + "Gold", + "Platinum" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n." + }, + "reverseProxyCertificate": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the certificate details." + }, + "reverseProxyCertificateCommonNames": { + "oneOf": [ + { + "$ref": "#/definitions/ServerCertificateCommonNames" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "upgradeDescription": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the policy used when upgrading the cluster." + }, + "upgradeMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Automatic", + "Manual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - 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.\n." + }, + "vmImage": { + "type": "string", + "description": "The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used." + } + }, + "required": [ + "managementEndpoint", + "nodeTypes" + ], + "description": "Describes the cluster resource properties." + }, + "ClusterUpgradeDeltaHealthPolicy": { + "type": "object", + "properties": { + "maxPercentDeltaUnhealthyNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.\nThe 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.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n" + }, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.\nThe 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.\nThe 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.\n" + }, + "maxPercentDeltaUnhealthyApplications": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades.\nThe 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.\nThe 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.\n" + }, + "applicationDeltaHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ApplicationDeltaHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a map that contains specific application delta health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n" + } + }, + "required": [ + "maxPercentDeltaUnhealthyNodes", + "maxPercentUpgradeDomainDeltaUnhealthyNodes", + "maxPercentDeltaUnhealthyApplications" + ], + "description": "Describes the delta health policies for the cluster upgrade." + }, + "ClusterUpgradePolicy": { + "type": "object", + "properties": { + "forceRestart": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "upgradeReplicaSetCheckTimeout": { + "type": "string", + "description": "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." + }, + "healthCheckWaitDuration": { + "type": "string", + "description": "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." + }, + "healthCheckStableDuration": { + "type": "string", + "description": "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." + }, + "healthCheckRetryTimeout": { + "type": "string", + "description": "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." + }, + "upgradeTimeout": { + "type": "string", + "description": "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." + }, + "upgradeDomainTimeout": { + "type": "string", + "description": "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." + }, + "healthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n" + }, + "deltaHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the delta health policies for the cluster upgrade." + } + }, + "required": [ + "upgradeReplicaSetCheckTimeout", + "healthCheckWaitDuration", + "healthCheckStableDuration", + "healthCheckRetryTimeout", + "upgradeTimeout", + "upgradeDomainTimeout", + "healthPolicy" + ], + "description": "Describes the policy used when upgrading the cluster." + }, + "DiagnosticsStorageAccountConfig": { + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The Azure storage account name." + }, + "protectedAccountKeyName": { + "type": "string", + "description": "The protected diagnostics storage key name." + }, + "blobEndpoint": { + "type": "string", + "description": "The blob endpoint of the azure storage account." + }, + "queueEndpoint": { + "type": "string", + "description": "The queue endpoint of the azure storage account." + }, + "tableEndpoint": { + "type": "string", + "description": "The table endpoint of the azure storage account." + } + }, + "required": [ + "storageAccountName", + "protectedAccountKeyName", + "blobEndpoint", + "queueEndpoint", + "tableEndpoint" + ], + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "EndpointRangeDescription": { + "type": "object", + "properties": { + "startPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Starting port of a range of ports" + }, + "endPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "End port of a range of ports" + } + }, + "required": [ + "startPort", + "endPort" + ], + "description": "Port range details" + }, + "NodeTypeDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the node type." + }, + "placementProperties": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run." + }, + "capacities": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The TCP cluster management endpoint port." + }, + "httpGatewayEndpointPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The HTTP cluster management endpoint port." + }, + "durabilityLevel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Bronze", + "Silver", + "Gold" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n - 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.\n." + }, + "applicationPorts": { + "oneOf": [ + { + "$ref": "#/definitions/EndpointRangeDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Port range details" + }, + "ephemeralPorts": { + "oneOf": [ + { + "$ref": "#/definitions/EndpointRangeDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Port range details" + }, + "isPrimary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "vmInstanceCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 2147483647 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource." + }, + "reverseProxyEndpointPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The endpoint used by reverse proxy." + } + }, + "required": [ + "name", + "clientConnectionEndpointPort", + "httpGatewayEndpointPort", + "isPrimary", + "vmInstanceCount" + ], + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "ServerCertificateCommonName": { + "type": "object", + "properties": { + "certificateCommonName": { + "type": "string", + "description": "The common name of the server certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the server certificate." + } + }, + "required": [ + "certificateCommonName", + "certificateIssuerThumbprint" + ], + "description": "Describes the server certificate details using common name." + }, + "ServerCertificateCommonNames": { + "type": "object", + "properties": { + "commonNames": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServerCertificateCommonName" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of server certificates referenced by common name that are used to secure the cluster." + }, + "x509StoreName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The local certificate store location." + } + }, + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "ServiceTypeDeltaHealthPolicy": { + "type": "object", + "properties": { + "maxPercentDeltaUnhealthyServices": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of services health degradation allowed during cluster upgrades.\nThe 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.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n" + } + }, + "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n" + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "properties": { + "maxPercentUnhealthyServices": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n" + } + }, + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "SettingsParameterDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The collection of parameters in the section." + } + }, + "required": [ + "name", + "parameters" + ], + "description": "Describes a section in the fabric settings of the cluster." + } + } +} diff --git a/test/Resource/Expected/Microsoft.ServiceFabric/2019-03-01-preview/Microsoft.ServiceFabric.json b/test/Resource/Expected/Microsoft.ServiceFabric/2019-03-01-preview/Microsoft.ServiceFabric.json new file mode 100644 index 0000000..7041600 --- /dev/null +++ b/test/Resource/Expected/Microsoft.ServiceFabric/2019-03-01-preview/Microsoft.ServiceFabric.json @@ -0,0 +1,2146 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-03-01-preview/Microsoft.ServiceFabric.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.ServiceFabric", + "description": "Microsoft ServiceFabric Resource Types", + "resourceDefinitions": { + "clusters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the cluster resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the cluster resource properties." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/clusters_applicationTypes_childResource" + }, + { + "$ref": "#/definitions/clusters_applications_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters" + }, + "clusters_applications": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters/applications" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The application resource properties." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/clusters_applications_services_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applications" + }, + "clusters_applications_services": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters/applications/services" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The service resource properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applications/services" + }, + "clusters_applicationTypes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application type name resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters/applicationTypes" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationTypeResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The application type name properties" + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/clusters_applicationTypes_versions_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applicationTypes" + }, + "clusters_applicationTypes_versions": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The application type version." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters/applicationTypes/versions" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the application type version resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applicationTypes/versions" + } + }, + "definitions": { + "ApplicationDeltaHealthPolicy": { + "type": "object", + "properties": { + "defaultServiceTypeDeltaHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n" + }, + "serviceTypeDeltaHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a map that contains specific delta health policies for different service types.\nEach entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.\nThe map is empty by default.\n" + } + }, + "description": "Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.\n" + }, + "ApplicationHealthPolicy": { + "type": "object", + "properties": { + "defaultServiceTypeHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "serviceTypeHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor 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.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n" + } + }, + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + }, + "ApplicationMetricDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "maximumCapacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum node capacity for Service Fabric application.\nThis 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.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\n" + }, + "reservationCapacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.\n" + }, + "totalApplicationCapacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The total metric capacity for Service Fabric application.\nThis 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.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.\n" + } + }, + "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.\n" + }, + "ApplicationResourceProperties": { + "type": "object", + "properties": { + "typeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest." + }, + "parameters": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "upgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the policy for a monitored application upgrade." + }, + "minimumNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "maximumNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "removeApplicationCapacity": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Remove the current application capacity settings." + }, + "metrics": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationMetricDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of application capacity metric description." + }, + "typeName": { + "type": "string", + "description": "The application type name as defined in the application manifest." + } + }, + "description": "The application resource properties." + }, + "ApplicationTypeResourceProperties": { + "type": "object", + "properties": {}, + "description": "The application type name properties" + }, + "ApplicationTypeVersionResourceProperties": { + "type": "object", + "properties": { + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + } + }, + "required": [ + "appPackageUrl" + ], + "description": "The properties of the application type version resource." + }, + "ApplicationUpgradePolicy": { + "type": "object", + "properties": { + "upgradeReplicaSetCheckTimeout": { + "type": "string", + "description": "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)." + }, + "forceRestart": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "$ref": "#/definitions/ArmRollingUpgradeMonitoringPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The policy used for monitoring the application upgrade" + }, + "applicationHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ArmApplicationHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + } + }, + "description": "Describes the policy for a monitored application upgrade." + }, + "ArmApplicationHealthPolicy": { + "type": "object", + "properties": { + "considerWarningAsError": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether warnings are treated with the same severity as errors." + }, + "maxPercentUnhealthyDeployedApplications": { + "oneOf": [ + { + "type": "integer", + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n" + }, + "defaultServiceTypeHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ArmServiceTypeHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "serviceTypeHealthPolicyMap": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ArmServiceTypeHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor 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.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n" + } + }, + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + }, + "ArmRollingUpgradeMonitoringPolicy": { + "type": "object", + "properties": { + "failureAction": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Rollback", + "Manual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The activation Mode of the service package." + }, + "healthCheckWaitDuration": { + "type": "string", + "default": "0", + "description": "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." + }, + "healthCheckStableDuration": { + "type": "string", + "default": "PT0H2M0S", + "description": "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." + }, + "healthCheckRetryTimeout": { + "type": "string", + "default": "PT0H10M0S", + "description": "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." + }, + "upgradeTimeout": { + "type": "string", + "default": "P10675199DT02H48M05.4775807S", + "description": "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." + }, + "upgradeDomainTimeout": { + "type": "string", + "default": "P10675199DT02H48M05.4775807S", + "description": "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." + } + }, + "description": "The policy used for monitoring the application upgrade" + }, + "ArmServiceTypeHealthPolicy": { + "type": "object", + "properties": { + "maxPercentUnhealthyServices": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n" + }, + "maxPercentUnhealthyPartitionsPerService": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error.\n" + }, + "maxPercentUnhealthyReplicasPerPartition": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error.\n" + } + }, + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "AzureActiveDirectory": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "CertificateDescription": { + "type": "object", + "properties": { + "thumbprint": { + "type": "string", + "description": "Thumbprint of the primary certificate." + }, + "thumbprintSecondary": { + "type": "string", + "description": "Thumbprint of the secondary certificate." + }, + "x509StoreName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The local certificate store location." + } + }, + "required": [ + "thumbprint" + ], + "description": "Describes the certificate details." + }, + "ClientCertificateCommonName": { + "type": "object", + "properties": { + "isAdmin": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateCommonName": { + "type": "string", + "description": "The common name of the client certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the client certificate." + } + }, + "required": [ + "isAdmin", + "certificateCommonName", + "certificateIssuerThumbprint" + ], + "description": "Describes the client certificate details using common name." + }, + "ClientCertificateThumbprint": { + "type": "object", + "properties": { + "isAdmin": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateThumbprint": { + "type": "string", + "description": "The thumbprint of the client certificate." + } + }, + "required": [ + "isAdmin", + "certificateThumbprint" + ], + "description": "Describes the client certificate details using thumbprint." + }, + "ClusterHealthPolicy": { + "type": "object", + "properties": { + "maxPercentUnhealthyNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.\n" + }, + "maxPercentUnhealthyApplications": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.\n" + }, + "applicationHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ApplicationHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n" + } + }, + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n" + }, + "ClusterProperties": { + "type": "object", + "properties": { + "addOnFeatures": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of add-on features to enable in the cluster." + }, + "azureActiveDirectory": { + "oneOf": [ + { + "$ref": "#/definitions/AzureActiveDirectory" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The settings to enable AAD authentication on the cluster." + }, + "certificate": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the certificate details." + }, + "certificateCommonNames": { + "oneOf": [ + { + "$ref": "#/definitions/ServerCertificateCommonNames" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "clientCertificateCommonNames": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificateCommonName" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of client certificates referenced by common name that are allowed to manage the cluster." + }, + "clientCertificateThumbprints": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificateThumbprint" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster." + }, + "clusterCodeVersion": { + "type": "string", + "description": "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**." + }, + "diagnosticsStorageAccountConfig": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsStorageAccountConfig" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "eventStoreServiceEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the event store service is enabled." + }, + "fabricSettings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of custom fabric settings to configure the cluster." + }, + "managementEndpoint": { + "type": "string", + "description": "The http management endpoint of the cluster." + }, + "nodeTypes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NodeTypeDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of node types in the cluster." + }, + "reliabilityLevel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "Bronze", + "Silver", + "Gold", + "Platinum" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n." + }, + "reverseProxyCertificate": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the certificate details." + }, + "reverseProxyCertificateCommonNames": { + "oneOf": [ + { + "$ref": "#/definitions/ServerCertificateCommonNames" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "upgradeDescription": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the policy used when upgrading the cluster." + }, + "upgradeMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Automatic", + "Manual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - 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.\n." + }, + "vmImage": { + "type": "string", + "description": "The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used." + } + }, + "required": [ + "managementEndpoint", + "nodeTypes" + ], + "description": "Describes the cluster resource properties." + }, + "clusters_applications_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application resource." + }, + "type": { + "type": "string", + "enum": [ + "applications" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The application resource properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applications" + }, + "clusters_applications_services_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}." + }, + "type": { + "type": "string", + "enum": [ + "services" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The service resource properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applications/services" + }, + "clusters_applicationTypes_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application type name resource." + }, + "type": { + "type": "string", + "enum": [ + "applicationTypes" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationTypeResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The application type name properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applicationTypes" + }, + "clusters_applicationTypes_versions_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The application type version." + }, + "type": { + "type": "string", + "enum": [ + "versions" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the application type version resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applicationTypes/versions" + }, + "ClusterUpgradeDeltaHealthPolicy": { + "type": "object", + "properties": { + "maxPercentDeltaUnhealthyNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.\nThe 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.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n" + }, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.\nThe 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.\nThe 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.\n" + }, + "maxPercentDeltaUnhealthyApplications": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades.\nThe 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.\nThe 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.\n" + }, + "applicationDeltaHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ApplicationDeltaHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a map that contains specific application delta health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n" + } + }, + "required": [ + "maxPercentDeltaUnhealthyNodes", + "maxPercentUpgradeDomainDeltaUnhealthyNodes", + "maxPercentDeltaUnhealthyApplications" + ], + "description": "Describes the delta health policies for the cluster upgrade." + }, + "ClusterUpgradePolicy": { + "type": "object", + "properties": { + "forceRestart": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "upgradeReplicaSetCheckTimeout": { + "type": "string", + "description": "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." + }, + "healthCheckWaitDuration": { + "type": "string", + "description": "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." + }, + "healthCheckStableDuration": { + "type": "string", + "description": "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." + }, + "healthCheckRetryTimeout": { + "type": "string", + "description": "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." + }, + "upgradeTimeout": { + "type": "string", + "description": "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." + }, + "upgradeDomainTimeout": { + "type": "string", + "description": "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." + }, + "healthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n" + }, + "deltaHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the delta health policies for the cluster upgrade." + } + }, + "required": [ + "upgradeReplicaSetCheckTimeout", + "healthCheckWaitDuration", + "healthCheckStableDuration", + "healthCheckRetryTimeout", + "upgradeTimeout", + "upgradeDomainTimeout", + "healthPolicy" + ], + "description": "Describes the policy used when upgrading the cluster." + }, + "DiagnosticsStorageAccountConfig": { + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The Azure storage account name." + }, + "protectedAccountKeyName": { + "type": "string", + "description": "The protected diagnostics storage key name." + }, + "blobEndpoint": { + "type": "string", + "description": "The blob endpoint of the azure storage account." + }, + "queueEndpoint": { + "type": "string", + "description": "The queue endpoint of the azure storage account." + }, + "tableEndpoint": { + "type": "string", + "description": "The table endpoint of the azure storage account." + } + }, + "required": [ + "storageAccountName", + "protectedAccountKeyName", + "blobEndpoint", + "queueEndpoint", + "tableEndpoint" + ], + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "EndpointRangeDescription": { + "type": "object", + "properties": { + "startPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Starting port of a range of ports" + }, + "endPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "End port of a range of ports" + } + }, + "required": [ + "startPort", + "endPort" + ], + "description": "Port range details" + }, + "NodeTypeDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the node type." + }, + "placementProperties": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run." + }, + "capacities": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The TCP cluster management endpoint port." + }, + "httpGatewayEndpointPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The HTTP cluster management endpoint port." + }, + "durabilityLevel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Bronze", + "Silver", + "Gold" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n - 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.\n." + }, + "applicationPorts": { + "oneOf": [ + { + "$ref": "#/definitions/EndpointRangeDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Port range details" + }, + "ephemeralPorts": { + "oneOf": [ + { + "$ref": "#/definitions/EndpointRangeDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Port range details" + }, + "isPrimary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "vmInstanceCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 2147483647 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource." + }, + "reverseProxyEndpointPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The endpoint used by reverse proxy." + } + }, + "required": [ + "name", + "clientConnectionEndpointPort", + "httpGatewayEndpointPort", + "isPrimary", + "vmInstanceCount" + ], + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "PartitionSchemeDescription": { + "type": "object", + "properties": {}, + "description": "Describes how the service is partitioned." + }, + "ServerCertificateCommonName": { + "type": "object", + "properties": { + "certificateCommonName": { + "type": "string", + "description": "The common name of the server certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the server certificate." + } + }, + "required": [ + "certificateCommonName", + "certificateIssuerThumbprint" + ], + "description": "Describes the server certificate details using common name." + }, + "ServerCertificateCommonNames": { + "type": "object", + "properties": { + "commonNames": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServerCertificateCommonName" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of server certificates referenced by common name that are used to secure the cluster." + }, + "x509StoreName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The local certificate store location." + } + }, + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "ServiceCorrelationDescription": { + "type": "object", + "properties": { + "scheme": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Invalid", + "Affinity", + "AlignedAffinity", + "NonAlignedAffinity" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "serviceName": { + "type": "string", + "description": "The full name of the service with 'fabric:' URI scheme." + } + }, + "required": [ + "scheme", + "serviceName" + ], + "description": "Creates a particular correlation between services." + }, + "ServiceLoadMetricDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "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." + }, + "weight": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "primaryDefaultLoad": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "defaultLoad": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + }, + "required": [ + "name" + ], + "description": "Specifies a metric to load balance a service during runtime." + }, + "ServicePlacementPolicyDescription": { + "type": "object", + "properties": {}, + "description": "Describes the policy to be used for placement of a Service Fabric service." + }, + "ServiceResourceProperties": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/StatefulServiceProperties" + }, + { + "$ref": "#/definitions/StatelessServiceProperties" + } + ], + "properties": { + "placementConstraints": { + "type": "string", + "description": "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)\"." + }, + "correlationScheme": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelationDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list that describes the correlation of the service with other services." + }, + "serviceLoadMetrics": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetricDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "servicePlacementPolicies": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list that describes the correlation of the service with other services." + }, + "defaultMoveCost": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the move cost for the service." + }, + "serviceTypeName": { + "type": "string", + "description": "The name of the service type" + }, + "partitionDescription": { + "oneOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes how the service is partitioned." + }, + "servicePackageActivationMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SharedProcess", + "ExclusiveProcess" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The activation Mode of the service package." + } + }, + "description": "The service resource properties." + }, + "ServiceTypeDeltaHealthPolicy": { + "type": "object", + "properties": { + "maxPercentDeltaUnhealthyServices": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of services health degradation allowed during cluster upgrades.\nThe 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.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n" + } + }, + "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n" + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "properties": { + "maxPercentUnhealthyServices": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n" + } + }, + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "SettingsParameterDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The collection of parameters in the section." + } + }, + "required": [ + "name", + "parameters" + ], + "description": "Describes a section in the fabric settings of the cluster." + }, + "StatefulServiceProperties": { + "type": "object", + "properties": { + "hasPersistedState": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "targetReplicaSetSize": { + "oneOf": [ + { + "type": "integer", + "minimum": 1 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "oneOf": [ + { + "type": "integer", + "minimum": 1 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "quorumLossWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "standByReplicaKeepDuration": { + "type": "string", + "format": "date-time", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "serviceKind": { + "type": "string", + "enum": [ + "Stateful" + ] + } + }, + "required": [ + "serviceKind" + ], + "description": "The properties of a stateful service resource." + }, + "StatelessServiceProperties": { + "type": "object", + "properties": { + "instanceCount": { + "oneOf": [ + { + "type": "integer", + "minimum": -1 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance count." + }, + "serviceKind": { + "type": "string", + "enum": [ + "Stateless" + ] + } + }, + "required": [ + "serviceKind" + ], + "description": "The properties of a stateless service resource." + } + } +} diff --git a/test/Resource/Expected/Microsoft.ServiceFabric/2019-03-01/Microsoft.ServiceFabric.json b/test/Resource/Expected/Microsoft.ServiceFabric/2019-03-01/Microsoft.ServiceFabric.json new file mode 100644 index 0000000..c437d6c --- /dev/null +++ b/test/Resource/Expected/Microsoft.ServiceFabric/2019-03-01/Microsoft.ServiceFabric.json @@ -0,0 +1,2146 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.ServiceFabric.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.ServiceFabric", + "description": "Microsoft ServiceFabric Resource Types", + "resourceDefinitions": { + "clusters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the cluster resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Azure resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the cluster resource properties." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/clusters_applicationTypes_childResource" + }, + { + "$ref": "#/definitions/clusters_applications_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters" + }, + "clusters_applications": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters/applications" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "It will be deprecated in New API, resource location depends on the parent resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The application resource properties." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/clusters_applications_services_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applications" + }, + "clusters_applications_services": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters/applications/services" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "It will be deprecated in New API, resource location depends on the parent resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The service resource properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applications/services" + }, + "clusters_applicationTypes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application type name resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters/applicationTypes" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "It will be deprecated in New API, resource location depends on the parent resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationTypeResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The application type name properties" + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/clusters_applicationTypes_versions_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applicationTypes" + }, + "clusters_applicationTypes_versions": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The application type version." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabric/clusters/applicationTypes/versions" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "It will be deprecated in New API, resource location depends on the parent resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the application type version resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applicationTypes/versions" + } + }, + "definitions": { + "ApplicationDeltaHealthPolicy": { + "type": "object", + "properties": { + "defaultServiceTypeDeltaHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n" + }, + "serviceTypeDeltaHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a map that contains specific delta health policies for different service types.\nEach entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.\nThe map is empty by default.\n" + } + }, + "description": "Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.\n" + }, + "ApplicationHealthPolicy": { + "type": "object", + "properties": { + "defaultServiceTypeHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "serviceTypeHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor 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.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n" + } + }, + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + }, + "ApplicationMetricDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "maximumCapacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum node capacity for Service Fabric application.\nThis 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.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\n" + }, + "reservationCapacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.\n" + }, + "totalApplicationCapacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The total metric capacity for Service Fabric application.\nThis 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.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.\n" + } + }, + "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.\n" + }, + "ApplicationResourceProperties": { + "type": "object", + "properties": { + "typeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest." + }, + "parameters": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "upgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the policy for a monitored application upgrade." + }, + "minimumNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "maximumNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "removeApplicationCapacity": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Remove the current application capacity settings." + }, + "metrics": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationMetricDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of application capacity metric description." + }, + "typeName": { + "type": "string", + "description": "The application type name as defined in the application manifest." + } + }, + "description": "The application resource properties." + }, + "ApplicationTypeResourceProperties": { + "type": "object", + "properties": {}, + "description": "The application type name properties" + }, + "ApplicationTypeVersionResourceProperties": { + "type": "object", + "properties": { + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + } + }, + "required": [ + "appPackageUrl" + ], + "description": "The properties of the application type version resource." + }, + "ApplicationUpgradePolicy": { + "type": "object", + "properties": { + "upgradeReplicaSetCheckTimeout": { + "type": "string", + "description": "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)." + }, + "forceRestart": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "$ref": "#/definitions/ArmRollingUpgradeMonitoringPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The policy used for monitoring the application upgrade" + }, + "applicationHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ArmApplicationHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + } + }, + "description": "Describes the policy for a monitored application upgrade." + }, + "ArmApplicationHealthPolicy": { + "type": "object", + "properties": { + "considerWarningAsError": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether warnings are treated with the same severity as errors." + }, + "maxPercentUnhealthyDeployedApplications": { + "oneOf": [ + { + "type": "integer", + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n" + }, + "defaultServiceTypeHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ArmServiceTypeHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "serviceTypeHealthPolicyMap": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ArmServiceTypeHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor 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.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n" + } + }, + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + }, + "ArmRollingUpgradeMonitoringPolicy": { + "type": "object", + "properties": { + "failureAction": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Rollback", + "Manual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The activation Mode of the service package." + }, + "healthCheckWaitDuration": { + "type": "string", + "default": "0", + "description": "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." + }, + "healthCheckStableDuration": { + "type": "string", + "default": "PT0H2M0S", + "description": "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." + }, + "healthCheckRetryTimeout": { + "type": "string", + "default": "PT0H10M0S", + "description": "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." + }, + "upgradeTimeout": { + "type": "string", + "default": "P10675199DT02H48M05.4775807S", + "description": "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." + }, + "upgradeDomainTimeout": { + "type": "string", + "default": "P10675199DT02H48M05.4775807S", + "description": "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." + } + }, + "description": "The policy used for monitoring the application upgrade" + }, + "ArmServiceTypeHealthPolicy": { + "type": "object", + "properties": { + "maxPercentUnhealthyServices": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n" + }, + "maxPercentUnhealthyPartitionsPerService": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error.\n" + }, + "maxPercentUnhealthyReplicasPerPartition": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error.\n" + } + }, + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "AzureActiveDirectory": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "CertificateDescription": { + "type": "object", + "properties": { + "thumbprint": { + "type": "string", + "description": "Thumbprint of the primary certificate." + }, + "thumbprintSecondary": { + "type": "string", + "description": "Thumbprint of the secondary certificate." + }, + "x509StoreName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The local certificate store location." + } + }, + "required": [ + "thumbprint" + ], + "description": "Describes the certificate details." + }, + "ClientCertificateCommonName": { + "type": "object", + "properties": { + "isAdmin": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateCommonName": { + "type": "string", + "description": "The common name of the client certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the client certificate." + } + }, + "required": [ + "isAdmin", + "certificateCommonName", + "certificateIssuerThumbprint" + ], + "description": "Describes the client certificate details using common name." + }, + "ClientCertificateThumbprint": { + "type": "object", + "properties": { + "isAdmin": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateThumbprint": { + "type": "string", + "description": "The thumbprint of the client certificate." + } + }, + "required": [ + "isAdmin", + "certificateThumbprint" + ], + "description": "Describes the client certificate details using thumbprint." + }, + "ClusterHealthPolicy": { + "type": "object", + "properties": { + "maxPercentUnhealthyNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.\n" + }, + "maxPercentUnhealthyApplications": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis 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.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.\n" + }, + "applicationHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ApplicationHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n" + } + }, + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n" + }, + "ClusterProperties": { + "type": "object", + "properties": { + "addOnFeatures": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of add-on features to enable in the cluster." + }, + "azureActiveDirectory": { + "oneOf": [ + { + "$ref": "#/definitions/AzureActiveDirectory" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The settings to enable AAD authentication on the cluster." + }, + "certificate": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the certificate details." + }, + "certificateCommonNames": { + "oneOf": [ + { + "$ref": "#/definitions/ServerCertificateCommonNames" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "clientCertificateCommonNames": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificateCommonName" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of client certificates referenced by common name that are allowed to manage the cluster." + }, + "clientCertificateThumbprints": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificateThumbprint" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster." + }, + "clusterCodeVersion": { + "type": "string", + "description": "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**." + }, + "diagnosticsStorageAccountConfig": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsStorageAccountConfig" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "eventStoreServiceEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates if the event store service is enabled." + }, + "fabricSettings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of custom fabric settings to configure the cluster." + }, + "managementEndpoint": { + "type": "string", + "description": "The http management endpoint of the cluster." + }, + "nodeTypes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NodeTypeDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of node types in the cluster." + }, + "reliabilityLevel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "Bronze", + "Silver", + "Gold", + "Platinum" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n." + }, + "reverseProxyCertificate": { + "oneOf": [ + { + "$ref": "#/definitions/CertificateDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the certificate details." + }, + "reverseProxyCertificateCommonNames": { + "oneOf": [ + { + "$ref": "#/definitions/ServerCertificateCommonNames" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "upgradeDescription": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the policy used when upgrading the cluster." + }, + "upgradeMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Automatic", + "Manual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - 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.\n." + }, + "vmImage": { + "type": "string", + "description": "The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used." + } + }, + "required": [ + "managementEndpoint", + "nodeTypes" + ], + "description": "Describes the cluster resource properties." + }, + "clusters_applications_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application resource." + }, + "type": { + "type": "string", + "enum": [ + "applications" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "It will be deprecated in New API, resource location depends on the parent resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The application resource properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applications" + }, + "clusters_applications_services_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}." + }, + "type": { + "type": "string", + "enum": [ + "services" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "It will be deprecated in New API, resource location depends on the parent resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The service resource properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applications/services" + }, + "clusters_applicationTypes_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the application type name resource." + }, + "type": { + "type": "string", + "enum": [ + "applicationTypes" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "It will be deprecated in New API, resource location depends on the parent resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationTypeResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The application type name properties" + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applicationTypes" + }, + "clusters_applicationTypes_versions_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The application type version." + }, + "type": { + "type": "string", + "enum": [ + "versions" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "It will be deprecated in New API, resource location depends on the parent resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of the application type version resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabric/clusters/applicationTypes/versions" + }, + "ClusterUpgradeDeltaHealthPolicy": { + "type": "object", + "properties": { + "maxPercentDeltaUnhealthyNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.\nThe 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.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n" + }, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.\nThe 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.\nThe 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.\n" + }, + "maxPercentDeltaUnhealthyApplications": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades.\nThe 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.\nThe 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.\n" + }, + "applicationDeltaHealthPolicies": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ApplicationDeltaHealthPolicy" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a map that contains specific application delta health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n" + } + }, + "required": [ + "maxPercentDeltaUnhealthyNodes", + "maxPercentUpgradeDomainDeltaUnhealthyNodes", + "maxPercentDeltaUnhealthyApplications" + ], + "description": "Describes the delta health policies for the cluster upgrade." + }, + "ClusterUpgradePolicy": { + "type": "object", + "properties": { + "forceRestart": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "upgradeReplicaSetCheckTimeout": { + "type": "string", + "description": "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." + }, + "healthCheckWaitDuration": { + "type": "string", + "description": "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." + }, + "healthCheckStableDuration": { + "type": "string", + "description": "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." + }, + "healthCheckRetryTimeout": { + "type": "string", + "description": "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." + }, + "upgradeTimeout": { + "type": "string", + "description": "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." + }, + "upgradeDomainTimeout": { + "type": "string", + "description": "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." + }, + "healthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n" + }, + "deltaHealthPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the delta health policies for the cluster upgrade." + } + }, + "required": [ + "upgradeReplicaSetCheckTimeout", + "healthCheckWaitDuration", + "healthCheckStableDuration", + "healthCheckRetryTimeout", + "upgradeTimeout", + "upgradeDomainTimeout", + "healthPolicy" + ], + "description": "Describes the policy used when upgrading the cluster." + }, + "DiagnosticsStorageAccountConfig": { + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The Azure storage account name." + }, + "protectedAccountKeyName": { + "type": "string", + "description": "The protected diagnostics storage key name." + }, + "blobEndpoint": { + "type": "string", + "description": "The blob endpoint of the azure storage account." + }, + "queueEndpoint": { + "type": "string", + "description": "The queue endpoint of the azure storage account." + }, + "tableEndpoint": { + "type": "string", + "description": "The table endpoint of the azure storage account." + } + }, + "required": [ + "storageAccountName", + "protectedAccountKeyName", + "blobEndpoint", + "queueEndpoint", + "tableEndpoint" + ], + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "EndpointRangeDescription": { + "type": "object", + "properties": { + "startPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Starting port of a range of ports" + }, + "endPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "End port of a range of ports" + } + }, + "required": [ + "startPort", + "endPort" + ], + "description": "Port range details" + }, + "NodeTypeDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the node type." + }, + "placementProperties": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run." + }, + "capacities": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The TCP cluster management endpoint port." + }, + "httpGatewayEndpointPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The HTTP cluster management endpoint port." + }, + "durabilityLevel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Bronze", + "Silver", + "Gold" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n - 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.\n." + }, + "applicationPorts": { + "oneOf": [ + { + "$ref": "#/definitions/EndpointRangeDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Port range details" + }, + "ephemeralPorts": { + "oneOf": [ + { + "$ref": "#/definitions/EndpointRangeDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Port range details" + }, + "isPrimary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "vmInstanceCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 2147483647 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource." + }, + "reverseProxyEndpointPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The endpoint used by reverse proxy." + } + }, + "required": [ + "name", + "clientConnectionEndpointPort", + "httpGatewayEndpointPort", + "isPrimary", + "vmInstanceCount" + ], + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "PartitionSchemeDescription": { + "type": "object", + "properties": {}, + "description": "Describes how the service is partitioned." + }, + "ServerCertificateCommonName": { + "type": "object", + "properties": { + "certificateCommonName": { + "type": "string", + "description": "The common name of the server certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the server certificate." + } + }, + "required": [ + "certificateCommonName", + "certificateIssuerThumbprint" + ], + "description": "Describes the server certificate details using common name." + }, + "ServerCertificateCommonNames": { + "type": "object", + "properties": { + "commonNames": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServerCertificateCommonName" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of server certificates referenced by common name that are used to secure the cluster." + }, + "x509StoreName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The local certificate store location." + } + }, + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "ServiceCorrelationDescription": { + "type": "object", + "properties": { + "scheme": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Invalid", + "Affinity", + "AlignedAffinity", + "NonAlignedAffinity" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "serviceName": { + "type": "string", + "description": "The full name of the service with 'fabric:' URI scheme." + } + }, + "required": [ + "scheme", + "serviceName" + ], + "description": "Creates a particular correlation between services." + }, + "ServiceLoadMetricDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "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." + }, + "weight": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "primaryDefaultLoad": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "defaultLoad": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + }, + "required": [ + "name" + ], + "description": "Specifies a metric to load balance a service during runtime." + }, + "ServicePlacementPolicyDescription": { + "type": "object", + "properties": {}, + "description": "Describes the policy to be used for placement of a Service Fabric service." + }, + "ServiceResourceProperties": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/StatefulServiceProperties" + }, + { + "$ref": "#/definitions/StatelessServiceProperties" + } + ], + "properties": { + "placementConstraints": { + "type": "string", + "description": "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)\"." + }, + "correlationScheme": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelationDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list that describes the correlation of the service with other services." + }, + "serviceLoadMetrics": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetricDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "servicePlacementPolicies": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list that describes the correlation of the service with other services." + }, + "defaultMoveCost": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the move cost for the service." + }, + "serviceTypeName": { + "type": "string", + "description": "The name of the service type" + }, + "partitionDescription": { + "oneOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes how the service is partitioned." + }, + "servicePackageActivationMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SharedProcess", + "ExclusiveProcess" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The activation Mode of the service package." + } + }, + "description": "The service resource properties." + }, + "ServiceTypeDeltaHealthPolicy": { + "type": "object", + "properties": { + "maxPercentDeltaUnhealthyServices": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum allowed percentage of services health degradation allowed during cluster upgrades.\nThe 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.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n" + } + }, + "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n" + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "properties": { + "maxPercentUnhealthyServices": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100, + "default": "0" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n" + } + }, + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n" + }, + "SettingsParameterDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The collection of parameters in the section." + } + }, + "required": [ + "name", + "parameters" + ], + "description": "Describes a section in the fabric settings of the cluster." + }, + "StatefulServiceProperties": { + "type": "object", + "properties": { + "hasPersistedState": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "targetReplicaSetSize": { + "oneOf": [ + { + "type": "integer", + "minimum": 1 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "oneOf": [ + { + "type": "integer", + "minimum": 1 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "quorumLossWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "standByReplicaKeepDuration": { + "type": "string", + "format": "date-time", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "serviceKind": { + "type": "string", + "enum": [ + "Stateful" + ] + } + }, + "required": [ + "serviceKind" + ], + "description": "The properties of a stateful service resource." + }, + "StatelessServiceProperties": { + "type": "object", + "properties": { + "instanceCount": { + "oneOf": [ + { + "type": "integer", + "minimum": -1 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance count." + }, + "serviceKind": { + "type": "string", + "enum": [ + "Stateless" + ] + } + }, + "required": [ + "serviceKind" + ], + "description": "The properties of a stateless service resource." + } + } +} diff --git a/test/Resource/Expected/Microsoft.ServiceFabricMesh/2018-07-01-preview/Microsoft.ServiceFabricMesh.json b/test/Resource/Expected/Microsoft.ServiceFabricMesh/2018-07-01-preview/Microsoft.ServiceFabricMesh.json new file mode 100644 index 0000000..f558d4a --- /dev/null +++ b/test/Resource/Expected/Microsoft.ServiceFabricMesh/2018-07-01-preview/Microsoft.ServiceFabricMesh.json @@ -0,0 +1,992 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-07-01-preview/Microsoft.ServiceFabricMesh.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.ServiceFabricMesh", + "description": "Microsoft ServiceFabricMesh Resource Types", + "resourceDefinitions": { + "applications": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The identity of the application." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabricMesh/applications" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01-preview" + ] + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes properties of an application resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/applications" + }, + "networks": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The identity of the network." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabricMesh/networks" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01-preview" + ] + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes properties of a network resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/networks" + }, + "volumes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The identity of the volume." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabricMesh/volumes" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01-preview" + ] + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VolumeResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes properties of a volume resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/volumes" + } + }, + "definitions": { + "ApplicationResourceProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the application." + }, + "debugParams": { + "type": "string", + "description": "Internal use." + }, + "services": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "describes the services in the application." + }, + "diagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the diagnostics options available" + } + }, + "description": "This type describes properties of an application resource." + }, + "AzureInternalMonitoringPipelineSinkDescription": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "Azure Internal monitoring pipeline account." + }, + "namespace": { + "type": "string", + "description": "Azure Internal monitoring pipeline account namespace." + }, + "maConfigUrl": { + "type": "string", + "description": "Azure Internal monitoring agent configuration." + }, + "fluentdConfigUrl": { + "type": "object", + "properties": {}, + "description": "Azure Internal monitoring agent fluentd configuration." + }, + "autoKeyConfigUrl": { + "type": "string", + "description": "Azure Internal monitoring pipeline autokey associated with the certificate." + }, + "kind": { + "type": "string", + "enum": [ + "AzureInternalMonitoringPipeline" + ] + } + }, + "required": [ + "kind" + ], + "description": "Diagnostics settings for Geneva." + }, + "ContainerCodePackageProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the code package." + }, + "image": { + "type": "string", + "description": "The Container image to use." + }, + "imageRegistryCredential": { + "oneOf": [ + { + "$ref": "#/definitions/ImageRegistryCredential" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Image registry credential." + }, + "entrypoint": { + "type": "string", + "description": "Override for the default entry point in the container." + }, + "commands": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Command array to execute within the container in exec form." + }, + "environmentVariables": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The environment variables to set in this container" + }, + "settings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Setting" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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\"." + }, + "labels": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerLabel" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The labels to set in this container." + }, + "endpoints": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The endpoints exposed by this container." + }, + "resources": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRequirements" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes the resource requirements for a container or a service." + }, + "volumeRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerVolume" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The volumes to be attached to the container." + }, + "diagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsRef" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "name", + "image", + "resources" + ], + "description": "Describes a container and its runtime properties." + }, + "ContainerLabel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the container label." + }, + "value": { + "type": "string", + "description": "The value of the container label." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes a container label." + }, + "ContainerVolume": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the volume." + }, + "readOnly": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The flag indicating whether the volume is read only. Default is 'false'." + }, + "destinationPath": { + "type": "string", + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed." + } + }, + "required": [ + "name", + "destinationPath" + ], + "description": "Describes how a volume is attached to a container." + }, + "DiagnosticsDescription": { + "type": "object", + "properties": { + "sinks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of supported sinks that can be referenced." + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Status of whether or not sinks are enabled." + }, + "defaultSinkRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level." + } + }, + "description": "Describes the diagnostics options available" + }, + "DiagnosticsRef": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Status of whether or not sinks are enabled." + }, + "sinkRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription." + } + }, + "description": "Reference to sinks in DiagnosticsDescription." + }, + "DiagnosticsSinkProperties": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/AzureInternalMonitoringPipelineSinkDescription" + } + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription" + }, + "description": { + "type": "string", + "description": "A description of the sink." + } + }, + "description": "Properties of a DiagnosticsSink." + }, + "EndpointProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the endpoint." + }, + "port": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Port used by the container." + } + }, + "required": [ + "name" + ], + "description": "Describes a container endpoint." + }, + "EnvironmentVariable": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + } + }, + "description": "Describes an environment variable for the container." + }, + "ImageRegistryCredential": { + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "Docker image registry server, without protocol such as `http` and `https`." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry." + } + }, + "required": [ + "server", + "username" + ], + "description": "Image registry credential." + }, + "IngressConfig": { + "type": "object", + "properties": { + "qosLevel": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Bronze" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The QoS tier for ingress." + }, + "layer4": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Layer4IngressConfig" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Configuration for layer4 public connectivity for this network." + } + }, + "description": "Describes public connectivity configuration for the network." + }, + "Layer4IngressConfig": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Layer4 ingress config name." + }, + "publicPort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the public port at which the service endpoint below needs to be exposed." + }, + "applicationName": { + "type": "string", + "description": "The application name which contains the service to be exposed." + }, + "serviceName": { + "type": "string", + "description": "The service whose endpoint needs to be exposed at the public port." + }, + "endpointName": { + "type": "string", + "description": "The service endpoint that needs to be exposed." + } + }, + "description": "Describes the layer4 configuration for public connectivity for this network." + }, + "NetworkRef": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the network." + } + }, + "description": "Describes a network reference in a service." + }, + "NetworkResourceProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the network." + }, + "addressPrefix": { + "type": "string", + "description": "the address prefix for this network." + }, + "ingressConfig": { + "oneOf": [ + { + "$ref": "#/definitions/IngressConfig" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes public connectivity configuration for the network." + } + }, + "required": [ + "addressPrefix" + ], + "description": "Describes properties of a network resource." + }, + "ResourceLimits": { + "type": "object", + "properties": { + "memoryInGB": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The memory limit in GB." + }, + "cpu": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CPU limits in cores. At present, only full cores are supported." + } + }, + "description": "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." + }, + "ResourceRequests": { + "type": "object", + "properties": { + "memoryInGB": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The memory request in GB for this container." + }, + "cpu": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Requested number of CPU cores. At present, only full cores are supported." + } + }, + "required": [ + "memoryInGB", + "cpu" + ], + "description": "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.\n" + }, + "ResourceRequirements": { + "type": "object", + "properties": { + "requests": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRequests" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.\n" + }, + "limits": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceLimits" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "required": [ + "requests" + ], + "description": "This type describes the resource requirements for a container or a service." + }, + "ServiceResourceDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes properties of a service resource." + } + }, + "required": [ + "properties" + ], + "description": "This type describes a service resource." + }, + "ServiceResourceProperties": { + "type": "object", + "properties": { + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Linux", + "Windows" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating system type required by the code in service.\n." + }, + "codePackages": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerCodePackageProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.).\n" + }, + "networkRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRef" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The names of the private networks that this service needs to be part of." + }, + "diagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsRef" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Reference to sinks in DiagnosticsDescription." + }, + "description": { + "type": "string", + "description": "User readable description of the service." + }, + "replicaCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas of the service to create. Defaults to 1 if not specified." + }, + "healthState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Invalid", + "Ok", + "Warning", + "Error", + "Unknown" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The health state of a resource such as Application, Service, or Network." + } + }, + "required": [ + "osType", + "codePackages" + ], + "description": "This type describes properties of a service resource." + }, + "Setting": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the setting." + }, + "value": { + "type": "string", + "description": "The value of the setting." + } + }, + "description": "Describes a setting for the container." + }, + "VolumeProviderParametersAzureFile": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "Name of the Azure storage account for the File Share." + }, + "accountKey": { + "type": "string", + "description": "Access key of the Azure storage account for the File Share." + }, + "shareName": { + "type": "string", + "description": "Name of the Azure Files file share that provides storage for the volume." + } + }, + "required": [ + "accountName", + "shareName" + ], + "description": "This type describes a volume provided by an Azure Files file share." + }, + "VolumeResourceProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the volume." + }, + "provider": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SFAzureFile" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Provider of the volume." + }, + "azureFileParameters": { + "oneOf": [ + { + "$ref": "#/definitions/VolumeProviderParametersAzureFile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes a volume provided by an Azure Files file share." + } + }, + "required": [ + "provider" + ], + "description": "Describes properties of a volume resource." + } + } +} diff --git a/test/Resource/Expected/Microsoft.ServiceFabricMesh/2018-09-01-preview/Microsoft.ServiceFabricMesh.json b/test/Resource/Expected/Microsoft.ServiceFabricMesh/2018-09-01-preview/Microsoft.ServiceFabricMesh.json new file mode 100644 index 0000000..5f98eef --- /dev/null +++ b/test/Resource/Expected/Microsoft.ServiceFabricMesh/2018-09-01-preview/Microsoft.ServiceFabricMesh.json @@ -0,0 +1,1757 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-09-01-preview/Microsoft.ServiceFabricMesh.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.ServiceFabricMesh", + "description": "Microsoft ServiceFabricMesh Resource Types", + "resourceDefinitions": { + "applications": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The identity of the application." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabricMesh/applications" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-09-01-preview" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes properties of an application resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/applications" + }, + "gateways": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The identity of the gateway." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabricMesh/gateways" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-09-01-preview" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GatewayResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes properties of a gateway resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/gateways" + }, + "networks": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The identity of the network." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabricMesh/networks" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-09-01-preview" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes properties of a network resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/networks" + }, + "secrets": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the secret resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabricMesh/secrets" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-09-01-preview" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SecretResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a secret resource." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/secrets_values_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/secrets" + }, + "secrets_values": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the secret resource value which is typically the version identifier for the value." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabricMesh/secrets/values" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-09-01-preview" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SecretValueResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes properties of a secret value resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/secrets/values" + }, + "volumes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The identity of the volume." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ServiceFabricMesh/volumes" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-09-01-preview" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VolumeResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes properties of a volume resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/volumes" + } + }, + "definitions": { + "ApplicationResourceProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the application." + }, + "services": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource." + }, + "diagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsDescription" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the diagnostics options available" + }, + "debugParams": { + "type": "string", + "description": "Internal - used by Visual Studio to setup the debugging session on the local development environment." + } + }, + "description": "This type describes properties of an application resource." + }, + "ApplicationScopedVolume": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the volume being referenced." + }, + "readOnly": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The flag indicating whether the volume is read only. Default is 'false'." + }, + "destinationPath": { + "type": "string", + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed." + }, + "creationParameters": { + "oneOf": [ + { + "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes parameters for creating application-scoped volumes." + } + }, + "required": [ + "name", + "destinationPath", + "creationParameters" + ], + "description": "Describes a volume whose lifetime is scoped to the application's lifetime." + }, + "ApplicationScopedVolumeCreationParameters": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk" + } + ], + "properties": { + "description": { + "type": "string", + "description": "User readable description of the volume." + } + }, + "description": "Describes parameters for creating application-scoped volumes." + }, + "ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk": { + "type": "object", + "properties": { + "sizeDisk": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Small", + "Medium", + "Large" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Volume size." + }, + "kind": { + "type": "string", + "enum": [ + "ServiceFabricVolumeDisk" + ] + } + }, + "required": [ + "sizeDisk", + "kind" + ], + "description": "Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks" + }, + "AutoScalingMechanism": { + "type": "object", + "properties": {}, + "description": "Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism." + }, + "AutoScalingPolicy": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the auto scaling policy." + }, + "trigger": { + "oneOf": [ + { + "$ref": "#/definitions/AutoScalingTrigger" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the trigger for performing auto scaling operation." + }, + "mechanism": { + "oneOf": [ + { + "$ref": "#/definitions/AutoScalingMechanism" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism." + } + }, + "required": [ + "name", + "trigger", + "mechanism" + ], + "description": "Describes the auto scaling policy" + }, + "AutoScalingTrigger": { + "type": "object", + "properties": {}, + "description": "Describes the trigger for performing auto scaling operation." + }, + "AzureInternalMonitoringPipelineSinkDescription": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "Azure Internal monitoring pipeline account." + }, + "namespace": { + "type": "string", + "description": "Azure Internal monitoring pipeline account namespace." + }, + "maConfigUrl": { + "type": "string", + "description": "Azure Internal monitoring agent configuration." + }, + "fluentdConfigUrl": { + "type": "object", + "properties": {}, + "description": "Azure Internal monitoring agent fluentd configuration." + }, + "autoKeyConfigUrl": { + "type": "string", + "description": "Azure Internal monitoring pipeline autokey associated with the certificate." + }, + "kind": { + "type": "string", + "enum": [ + "AzureInternalMonitoringPipeline" + ] + } + }, + "required": [ + "kind" + ], + "description": "Diagnostics settings for Geneva." + }, + "ContainerCodePackageProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the code package." + }, + "image": { + "type": "string", + "description": "The Container image to use." + }, + "imageRegistryCredential": { + "oneOf": [ + { + "$ref": "#/definitions/ImageRegistryCredential" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Image registry credential." + }, + "entrypoint": { + "type": "string", + "description": "Override for the default entry point in the container." + }, + "commands": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Command array to execute within the container in exec form." + }, + "environmentVariables": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The environment variables to set in this container" + }, + "settings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/Setting" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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\"." + }, + "labels": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerLabel" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The labels to set in this container." + }, + "endpoints": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The endpoints exposed by this container." + }, + "resources": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRequirements" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes the resource requirements for a container or a service." + }, + "volumeRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VolumeReference" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime." + }, + "volumes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationScopedVolume" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime." + }, + "diagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsRef" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Reference to sinks in DiagnosticsDescription." + }, + "reliableCollectionsRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ReliableCollectionsRef" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details." + } + }, + "required": [ + "name", + "image", + "resources" + ], + "description": "Describes a container and its runtime properties." + }, + "ContainerLabel": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the container label." + }, + "value": { + "type": "string", + "description": "The value of the container label." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes a container label." + }, + "DiagnosticsDescription": { + "type": "object", + "properties": { + "sinks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of supported sinks that can be referenced." + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Status of whether or not sinks are enabled." + }, + "defaultSinkRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level." + } + }, + "description": "Describes the diagnostics options available" + }, + "DiagnosticsRef": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Status of whether or not sinks are enabled." + }, + "sinkRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription." + } + }, + "description": "Reference to sinks in DiagnosticsDescription." + }, + "DiagnosticsSinkProperties": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/AzureInternalMonitoringPipelineSinkDescription" + } + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription" + }, + "description": { + "type": "string", + "description": "A description of the sink." + } + }, + "description": "Properties of a DiagnosticsSink." + }, + "EndpointProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the endpoint." + }, + "port": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Port used by the container." + } + }, + "required": [ + "name" + ], + "description": "Describes a container endpoint." + }, + "EndpointRef": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint." + } + }, + "description": "Describes a reference to a service endpoint." + }, + "EnvironmentVariable": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + } + }, + "description": "Describes an environment variable for the container." + }, + "GatewayDestination": { + "type": "object", + "properties": { + "applicationName": { + "type": "string", + "description": "Name of the service fabric Mesh application." + }, + "serviceName": { + "type": "string", + "description": "service that contains the endpoint." + }, + "endpointName": { + "type": "string", + "description": "name of the endpoint in the service." + } + }, + "required": [ + "applicationName", + "serviceName", + "endpointName" + ], + "description": "Describes destination endpoint for routing traffic." + }, + "GatewayResourceProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the gateway." + }, + "sourceNetwork": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRef" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a network reference in a service." + }, + "destinationNetwork": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkRef" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a network reference in a service." + }, + "tcp": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/TcpConfig" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Configuration for tcp connectivity for this gateway." + }, + "http": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/HttpConfig" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Configuration for http connectivity for this gateway." + } + }, + "required": [ + "sourceNetwork", + "destinationNetwork" + ], + "description": "This type describes properties of a gateway resource." + }, + "HttpConfig": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http gateway config name." + }, + "port": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the port at which the service endpoint below needs to be exposed." + }, + "hosts": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/HttpHostConfig" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "description for routing." + } + }, + "required": [ + "name", + "port", + "hosts" + ], + "description": "Describes the http configuration for external connectivity for this network." + }, + "HttpHostConfig": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http hostname config name." + }, + "routes": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/HttpRouteConfig" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases." + } + }, + "required": [ + "name", + "routes" + ], + "description": "Describes the hostname properties for http routing." + }, + "HttpRouteConfig": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http route name." + }, + "match": { + "oneOf": [ + { + "$ref": "#/definitions/HttpRouteMatchRule" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a rule for http route matching." + }, + "destination": { + "oneOf": [ + { + "$ref": "#/definitions/GatewayDestination" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes destination endpoint for routing traffic." + } + }, + "required": [ + "name", + "match", + "destination" + ], + "description": "Describes the hostname properties for http routing." + }, + "HttpRouteMatchHeader": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of header to match in request." + }, + "value": { + "type": "string", + "description": "Value of header to match in request." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "exact" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "how to match header value." + } + }, + "required": [ + "name" + ], + "description": "Describes header information for http route matching." + }, + "HttpRouteMatchPath": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Uri path to match for request." + }, + "rewrite": { + "type": "string", + "description": "replacement string for matched part of the Uri." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "prefix" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "how to match value in the Uri" + } + }, + "required": [ + "value", + "type" + ], + "description": "Path to match for routing." + }, + "HttpRouteMatchRule": { + "type": "object", + "properties": { + "path": { + "oneOf": [ + { + "$ref": "#/definitions/HttpRouteMatchPath" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Path to match for routing." + }, + "headers": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/HttpRouteMatchHeader" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "headers and their values to match in request." + } + }, + "required": [ + "path" + ], + "description": "Describes a rule for http route matching." + }, + "ImageRegistryCredential": { + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "Docker image registry server, without protocol such as `http` and `https`." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "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." + } + }, + "required": [ + "server", + "username" + ], + "description": "Image registry credential." + }, + "InlinedValueSecretResourceProperties": { + "type": "object", + "properties": { + "kind": { + "type": "string", + "enum": [ + "inlinedValue" + ] + } + }, + "required": [ + "kind" + ], + "description": "Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it." + }, + "LocalNetworkResourceProperties": { + "type": "object", + "properties": { + "networkAddressPrefix": { + "type": "string", + "description": "Address space for a container network. This is expressed in CIDR notation." + }, + "kind": { + "type": "string", + "enum": [ + "Local" + ] + } + }, + "required": [ + "kind" + ], + "description": "Information about a Service Fabric container network local to a single Service Fabric cluster." + }, + "NetworkRef": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the network" + }, + "endpointRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointRef" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of endpoints that are exposed on this network." + } + }, + "description": "Describes a network reference in a service." + }, + "NetworkResourceProperties": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/LocalNetworkResourceProperties" + } + ], + "properties": { + "description": { + "type": "string", + "description": "User readable description of the network." + } + }, + "description": "Describes properties of a network resource." + }, + "ReliableCollectionsRef": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of ReliableCollection resource. Right now it's not used and you can use any string." + }, + "doNotPersistState": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "required": [ + "name" + ], + "description": "Specifying this parameter adds support for reliable collections" + }, + "ResourceLimits": { + "type": "object", + "properties": { + "memoryInGB": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The memory limit in GB." + }, + "cpu": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CPU limits in cores. At present, only full cores are supported." + } + }, + "description": "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." + }, + "ResourceRequests": { + "type": "object", + "properties": { + "memoryInGB": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The memory request in GB for this container." + }, + "cpu": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Requested number of CPU cores. At present, only full cores are supported." + } + }, + "required": [ + "memoryInGB", + "cpu" + ], + "description": "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." + }, + "ResourceRequirements": { + "type": "object", + "properties": { + "requests": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRequests" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "limits": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceLimits" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "required": [ + "requests" + ], + "description": "This type describes the resource requirements for a container or a service." + }, + "SecretResourceProperties": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/InlinedValueSecretResourceProperties" + } + ], + "properties": { + "description": { + "type": "string", + "description": "User readable description of the secret." + }, + "contentType": { + "type": "string", + "description": "The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed." + } + }, + "description": "Describes the properties of a secret resource." + }, + "secrets_values_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the secret resource value which is typically the version identifier for the value." + }, + "type": { + "type": "string", + "enum": [ + "values" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-09-01-preview" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SecretValueResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes properties of a secret value resource." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.ServiceFabricMesh/secrets/values" + }, + "SecretValueResourceProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The actual value of the secret." + } + }, + "description": "This type describes properties of a secret value resource." + }, + "ServiceResourceDescription": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes properties of a service resource." + } + }, + "required": [ + "properties" + ], + "description": "This type describes a service resource." + }, + "ServiceResourceProperties": { + "type": "object", + "properties": { + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Linux", + "Windows" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The operation system required by the code in service." + }, + "codePackages": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerCodePackageProperties" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.)." + }, + "networkRefs": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRef" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The names of the private networks that this service needs to be part of." + }, + "diagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsRef" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Reference to sinks in DiagnosticsDescription." + }, + "description": { + "type": "string", + "description": "User readable description of the service." + }, + "replicaCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas of the service to create. Defaults to 1 if not specified." + }, + "autoScalingPolicies": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/AutoScalingPolicy" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Auto scaling policies" + } + }, + "required": [ + "osType", + "codePackages" + ], + "description": "This type describes properties of a service resource." + }, + "Setting": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the setting." + }, + "value": { + "type": "string", + "description": "The value of the setting." + } + }, + "description": "Describes a setting for the 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\"." + }, + "TcpConfig": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "tcp gateway config name." + }, + "port": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the port at which the service endpoint below needs to be exposed." + }, + "destination": { + "oneOf": [ + { + "$ref": "#/definitions/GatewayDestination" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes destination endpoint for routing traffic." + } + }, + "required": [ + "name", + "port", + "destination" + ], + "description": "Describes the tcp configuration for external connectivity for this network." + }, + "VolumeProviderParametersAzureFile": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "Name of the Azure storage account for the File Share." + }, + "accountKey": { + "type": "string", + "description": "Access key of the Azure storage account for the File Share." + }, + "shareName": { + "type": "string", + "description": "Name of the Azure Files file share that provides storage for the volume." + } + }, + "required": [ + "accountName", + "shareName" + ], + "description": "This type describes a volume provided by an Azure Files file share." + }, + "VolumeReference": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the volume being referenced." + }, + "readOnly": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The flag indicating whether the volume is read only. Default is 'false'." + }, + "destinationPath": { + "type": "string", + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed." + } + }, + "required": [ + "name", + "destinationPath" + ], + "description": "Describes a reference to a volume resource." + }, + "VolumeResourceProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the volume." + }, + "provider": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SFAzureFile" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Provider of the volume." + }, + "azureFileParameters": { + "oneOf": [ + { + "$ref": "#/definitions/VolumeProviderParametersAzureFile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This type describes a volume provided by an Azure Files file share." + } + }, + "required": [ + "provider" + ], + "description": "This type describes properties of a volume resource." + } + } +} diff --git a/test/Resource/Expected/Microsoft.SqlVirtualMachine/2017-03-01-preview/Microsoft.SqlVirtualMachine.json b/test/Resource/Expected/Microsoft.SqlVirtualMachine/2017-03-01-preview/Microsoft.SqlVirtualMachine.json new file mode 100644 index 0000000..0bf10e2 --- /dev/null +++ b/test/Resource/Expected/Microsoft.SqlVirtualMachine/2017-03-01-preview/Microsoft.SqlVirtualMachine.json @@ -0,0 +1,962 @@ +{ + "id": "https://schema.management.azure.com/schemas/2017-03-01-preview/Microsoft.SqlVirtualMachine.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.SqlVirtualMachine", + "description": "Microsoft SqlVirtualMachine Resource Types", + "resourceDefinitions": { + "sqlVirtualMachineGroups": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the SQL virtual machine group." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlVirtualMachineGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of a SQL virtual machine group." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/sqlVirtualMachineGroups_availabilityGroupListeners_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + }, + "sqlVirtualMachineGroups_availabilityGroupListeners": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the availability group listener." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-03-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AvailabilityGroupListenerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of an availability group listener." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners" + }, + "sqlVirtualMachines": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the SQL virtual machine." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-03-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Azure Active Directory identity configuration for a resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SqlVirtualMachineProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The SQL virtual machine properties." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + }, + "definitions": { + "AdditionalFeaturesServerConfigurations": { + "type": "object", + "properties": { + "isRServicesEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable or disable R services (SQL 2016 onwards)." + } + }, + "description": "Additional SQL Server feature settings." + }, + "AutoBackupSettings": { + "type": "object", + "properties": { + "enable": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable or disable autobackup on SQL virtual machine." + }, + "enableEncryption": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable or disable encryption for backup on SQL virtual machine." + }, + "retentionPeriod": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Retention period of backup: 1-30 days." + }, + "storageAccountUrl": { + "type": "string", + "description": "Storage account url where backup will be taken to." + }, + "storageAccessKey": { + "type": "string", + "description": "Storage account key where backup will be taken to." + }, + "password": { + "type": "string", + "description": "Password for encryption on backup." + }, + "backupSystemDbs": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Include or exclude system databases from auto backup." + }, + "backupScheduleType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Manual", + "Automated" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Backup schedule type." + }, + "fullBackupFrequency": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Daily", + "Weekly" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Frequency of full backups. In both cases, full backups begin during the next scheduled time window." + }, + "fullBackupStartTime": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Start time of a given day during which full backups can take place. 0-23 hours." + }, + "fullBackupWindowHours": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Duration of the time window of a given day during which full backups can take place. 1-23 hours." + }, + "logBackupFrequency": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Frequency of log backups. 5-60 minutes." + } + }, + "description": "Configure backups for databases in your SQL virtual machine." + }, + "AutoPatchingSettings": { + "type": "object", + "properties": { + "enable": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable or disable autopatching on SQL virtual machine." + }, + "dayOfWeek": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Day of week to apply the patch on." + }, + "maintenanceWindowStartingHour": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Hour of the day when patching is initiated. Local VM time." + }, + "maintenanceWindowDuration": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Duration of patching." + } + }, + "description": "Set a patching window during which Windows and SQL patches will be applied." + }, + "AvailabilityGroupListenerProperties": { + "type": "object", + "properties": { + "availabilityGroupName": { + "type": "string", + "description": "Name of the availability group." + }, + "loadBalancerConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancerConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of load balancer configurations for an availability group listener." + }, + "createDefaultAvailabilityGroupIfNotExist": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Create a default availability group if it does not exist." + }, + "port": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Listener port." + } + }, + "description": "The properties of an availability group listener." + }, + "KeyVaultCredentialSettings": { + "type": "object", + "properties": { + "enable": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enable or disable key vault credential setting." + }, + "credentialName": { + "type": "string", + "description": "Credential name." + }, + "azureKeyVaultUrl": { + "type": "string", + "description": "Azure Key Vault url." + }, + "servicePrincipalName": { + "type": "string", + "description": "Service principal name to access key vault." + }, + "servicePrincipalSecret": { + "type": "string", + "description": "Service principal name secret to access key vault." + } + }, + "description": "Configure your SQL virtual machine to be able to connect to the Azure Key Vault service." + }, + "LoadBalancerConfiguration": { + "type": "object", + "properties": { + "privateIpAddress": { + "oneOf": [ + { + "$ref": "#/definitions/PrivateIPAddress" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A private IP address bound to the availability group listener." + }, + "publicIpAddressResourceId": { + "type": "string", + "description": "Resource id of the public IP." + }, + "loadBalancerResourceId": { + "type": "string", + "description": "Resource id of the load balancer." + }, + "probePort": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Probe port." + }, + "sqlVirtualMachineInstances": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener." + } + }, + "description": "A load balancer configuration for an availability group listener." + }, + "PrivateIPAddress": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "description": "Private IP address bound to the availability group listener." + }, + "subnetResourceId": { + "type": "string", + "description": "Subnet used to include private IP." + } + }, + "description": "A private IP address bound to the availability group listener." + }, + "ResourceIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource." + } + }, + "description": "Azure Active Directory identity configuration for a resource." + }, + "ServerConfigurationsManagementSettings": { + "type": "object", + "properties": { + "sqlConnectivityUpdateSettings": { + "oneOf": [ + { + "$ref": "#/definitions/SqlConnectivityUpdateSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set the access level and network port settings for SQL Server." + }, + "sqlWorkloadTypeUpdateSettings": { + "oneOf": [ + { + "$ref": "#/definitions/SqlWorkloadTypeUpdateSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set workload type to optimize storage for SQL Server." + }, + "sqlStorageUpdateSettings": { + "oneOf": [ + { + "$ref": "#/definitions/SqlStorageUpdateSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set disk storage settings for SQL Server." + }, + "additionalFeaturesServerConfigurations": { + "oneOf": [ + { + "$ref": "#/definitions/AdditionalFeaturesServerConfigurations" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Additional SQL Server feature settings." + } + }, + "description": "Set the connectivity, storage and workload settings." + }, + "SqlConnectivityUpdateSettings": { + "type": "object", + "properties": { + "connectivityType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "LOCAL", + "PRIVATE", + "PUBLIC" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SQL Server connectivity option." + }, + "port": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SQL Server port." + }, + "sqlAuthUpdateUserName": { + "type": "string", + "description": "SQL Server sysadmin login to create." + }, + "sqlAuthUpdatePassword": { + "type": "string", + "description": "SQL Server sysadmin login password." + } + }, + "description": "Set the access level and network port settings for SQL Server." + }, + "SqlStorageUpdateSettings": { + "type": "object", + "properties": { + "diskCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Virtual machine disk count." + }, + "startingDeviceId": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Device id of the first disk to be updated." + }, + "diskConfigurationType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "NEW", + "EXTEND", + "ADD" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Disk configuration to apply to SQL Server." + } + }, + "description": "Set disk storage settings for SQL Server." + }, + "SqlVirtualMachineGroupProperties": { + "type": "object", + "properties": { + "sqlImageOffer": { + "type": "string", + "description": "SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016." + }, + "sqlImageSku": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Developer", + "Enterprise" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SQL image sku." + }, + "wsfcDomainProfile": { + "oneOf": [ + { + "$ref": "#/definitions/WsfcDomainProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Active Directory account details to operate Windows Server Failover Cluster." + } + }, + "description": "The properties of a SQL virtual machine group." + }, + "sqlVirtualMachineGroups_availabilityGroupListeners_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the availability group listener." + }, + "type": { + "type": "string", + "enum": [ + "availabilityGroupListeners" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-03-01-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AvailabilityGroupListenerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of an availability group listener." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners" + }, + "SqlVirtualMachineProperties": { + "type": "object", + "properties": { + "virtualMachineResourceId": { + "type": "string", + "description": "ARM Resource id of underlying virtual machine created from SQL marketplace image." + }, + "sqlImageOffer": { + "type": "string", + "description": "SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016." + }, + "sqlServerLicenseType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "PAYG", + "AHUB" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SQL Server license type." + }, + "sqlManagement": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Full", + "LightWeight", + "NoAgent" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SQL Server Management type." + }, + "sqlImageSku": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Developer", + "Express", + "Standard", + "Enterprise", + "Web" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SQL Server edition type." + }, + "sqlVirtualMachineGroupResourceId": { + "type": "string", + "description": "ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of." + }, + "wsfcDomainCredentials": { + "oneOf": [ + { + "$ref": "#/definitions/WsfcDomainCredentials" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group." + }, + "autoPatchingSettings": { + "oneOf": [ + { + "$ref": "#/definitions/AutoPatchingSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set a patching window during which Windows and SQL patches will be applied." + }, + "autoBackupSettings": { + "oneOf": [ + { + "$ref": "#/definitions/AutoBackupSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Configure backups for databases in your SQL virtual machine." + }, + "keyVaultCredentialSettings": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultCredentialSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Configure your SQL virtual machine to be able to connect to the Azure Key Vault service." + }, + "serverConfigurationsManagementSettings": { + "oneOf": [ + { + "$ref": "#/definitions/ServerConfigurationsManagementSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set the connectivity, storage and workload settings." + } + }, + "description": "The SQL virtual machine properties." + }, + "SqlWorkloadTypeUpdateSettings": { + "type": "object", + "properties": { + "sqlWorkloadType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "GENERAL", + "OLTP", + "DW" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SQL Server workload type." + } + }, + "description": "Set workload type to optimize storage for SQL Server." + }, + "WsfcDomainCredentials": { + "type": "object", + "properties": { + "clusterBootstrapAccountPassword": { + "type": "string", + "description": "Cluster bootstrap account password." + }, + "clusterOperatorAccountPassword": { + "type": "string", + "description": "Cluster operator account password." + }, + "sqlServiceAccountPassword": { + "type": "string", + "description": "SQL service account password." + } + }, + "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group." + }, + "WsfcDomainProfile": { + "type": "object", + "properties": { + "domainFqdn": { + "type": "string", + "description": "Fully qualified name of the domain." + }, + "ouPath": { + "type": "string", + "description": "Organizational Unit path in which the nodes and cluster will be present." + }, + "clusterBootstrapAccount": { + "type": "string", + "description": "Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain)." + }, + "clusterOperatorAccount": { + "type": "string", + "description": "Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster." + }, + "sqlServiceAccount": { + "type": "string", + "description": "Account name under which SQL service will run on all participating SQL virtual machines in the cluster." + }, + "fileShareWitnessPath": { + "type": "string", + "description": "Optional path for fileshare witness." + }, + "storageAccountUrl": { + "type": "string", + "description": "Fully qualified ARM resource id of the witness storage account." + }, + "storageAccountPrimaryKey": { + "type": "string", + "description": "Primary key of the witness storage account." + } + }, + "description": "Active Directory account details to operate Windows Server Failover Cluster." + } + } +} diff --git a/test/Resource/Expected/Microsoft.StorageSync/2017-06-05-preview/Microsoft.StorageSync.json b/test/Resource/Expected/Microsoft.StorageSync/2017-06-05-preview/Microsoft.StorageSync.json new file mode 100644 index 0000000..d3b8b92 --- /dev/null +++ b/test/Resource/Expected/Microsoft.StorageSync/2017-06-05-preview/Microsoft.StorageSync.json @@ -0,0 +1,699 @@ +{ + "id": "https://schema.management.azure.com/schemas/2017-06-05-preview/Microsoft.StorageSync.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.StorageSync", + "description": "Microsoft StorageSync Resource Types", + "resourceDefinitions": { + "storageSyncServices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Storage Sync Service resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-05-preview" + ] + }, + "location": { + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "type": "object", + "properties": {}, + "description": "The tags of the resource." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/StorageSyncServiceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Storage Sync Service Properties object." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_registeredServers_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices" + }, + "storageSyncServices_registeredServers": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-05-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "RegisteredServer Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-05-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SyncGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SyncGroup Properties object." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_cloudEndpoints_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_syncGroups_serverEndpoints_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-05-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-05-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "ServerEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "definitions": { + "CloudEndpointProperties": { + "type": "object", + "properties": { + "storageAccountKey": { + "type": "string", + "description": "Storage Account access key." + }, + "storageAccount": { + "type": "string", + "description": "Storage Account name." + }, + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "storageAccountShareName": { + "type": "string", + "description": "Storage Account Share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + }, + "partnershipId": { + "type": "string", + "description": "Partnership Id" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "provisioningState": { + "type": "string", + "description": "CloudEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "CloudEndpoint lastWorkflowId" + } + }, + "description": "CloudEndpoint Properties object." + }, + "RegisteredServerProperties": { + "type": "object", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "serverManagementtErrorCode": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Registered Server Management Error Code" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "provisioningState": { + "type": "string", + "description": "Registered Server Provisioning State" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "storageSyncServiceUid": { + "type": "string", + "description": "Registered Server storageSyncServiceUid" + }, + "lastWorkflowId": { + "type": "string", + "description": "Registered Server lastWorkflowId" + } + }, + "description": "RegisteredServer Properties object." + }, + "ServerEndpointProperties": { + "type": "object", + "properties": { + "serverLocalPath": { + "type": "string", + "description": "Server folder used for data synchronization" + }, + "cloudTiering": { + "oneOf": [ + { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "lastSyncSuccess": { + "type": "string", + "format": "date-time", + "description": "Last Sync Success" + }, + "syncErrorState": { + "type": "string", + "description": "Sync Error State" + }, + "syncErrorStateTimestamp": { + "type": "string", + "format": "date-time", + "description": "Sync Error State Timestamp" + }, + "syncErrorDirection": { + "oneOf": [ + { + "type": "string", + "enum": [ + "none", + "initialize", + "download", + "upload", + "recall" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Sync Error Direction." + }, + "itemUploadErrorCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Item Upload Error Count." + }, + "itemDownloadErrorCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Item download error count." + }, + "syncErrorContext": { + "type": "string", + "description": "sync error context." + }, + "currentProgressType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "none", + "initialize", + "download", + "upload", + "recall" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "current progress type." + }, + "itemProgressCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Item Progress Count" + }, + "itemTotalCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Item Total Count" + }, + "byteProgress": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Bytes in progress" + }, + "totalProgress": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Total progress" + }, + "byteTotal": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Bytes total" + }, + "serverResourceId": { + "type": "string", + "description": "Arm resource identifier." + }, + "provisioningState": { + "type": "string", + "description": "ServerEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "ServerEndpoint lastWorkflowId" + } + }, + "description": "ServerEndpoint Properties object." + }, + "StorageSyncServiceProperties": { + "type": "object", + "properties": {}, + "description": "Storage Sync Service Properties object." + }, + "storageSyncServices_registeredServers_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-05-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "RegisteredServer Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-05-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SyncGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SyncGroup Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-05-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2017-06-05-preview" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "ServerEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + "SyncGroupProperties": { + "type": "object", + "properties": { + "uniqueId": { + "type": "string", + "description": "Unique Id" + } + }, + "description": "SyncGroup Properties object." + } + } +} diff --git a/test/Resource/Expected/Microsoft.StorageSync/2018-04-02/Microsoft.StorageSync.json b/test/Resource/Expected/Microsoft.StorageSync/2018-04-02/Microsoft.StorageSync.json new file mode 100644 index 0000000..7bcf02f --- /dev/null +++ b/test/Resource/Expected/Microsoft.StorageSync/2018-04-02/Microsoft.StorageSync.json @@ -0,0 +1,637 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-04-02/Microsoft.StorageSync.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.StorageSync", + "description": "Microsoft StorageSync Resource Types", + "resourceDefinitions": { + "storageSyncServices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Storage Sync Service resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-02" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_registeredServers_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.StorageSync/storageSyncServices" + }, + "storageSyncServices_registeredServers": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-02" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-02" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_cloudEndpoints_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_syncGroups_serverEndpoints_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-02" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersPropertiesModelModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-02" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersPropertiesModelModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "ServerEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "definitions": { + "CloudEndpointCreateParametersPropertiesModelModel": { + "type": "object", + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "storageAccountShareName": { + "type": "string", + "description": "Storage Account Share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + } + }, + "description": "CloudEndpoint Properties object." + }, + "RegisteredServerCreateParametersProperties": { + "type": "object", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + } + } + }, + "ServerEndpointCreateParametersPropertiesModelModel": { + "type": "object", + "properties": { + "serverLocalPath": { + "type": "string", + "description": "Server folder used for data synchronization" + }, + "cloudTiering": { + "oneOf": [ + { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "serverResourceId": { + "type": "string", + "description": "Arm resource identifier." + } + }, + "description": "ServerEndpoint Properties object." + }, + "storageSyncServices_registeredServers_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-02" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-02" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-02" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersPropertiesModelModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-02" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersPropertiesModelModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "ServerEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } +} diff --git a/test/Resource/Expected/Microsoft.StorageSync/2018-07-01/Microsoft.StorageSync.json b/test/Resource/Expected/Microsoft.StorageSync/2018-07-01/Microsoft.StorageSync.json new file mode 100644 index 0000000..5c8b7dc --- /dev/null +++ b/test/Resource/Expected/Microsoft.StorageSync/2018-07-01/Microsoft.StorageSync.json @@ -0,0 +1,504 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-07-01/Microsoft.StorageSync.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.StorageSync", + "description": "Microsoft StorageSync Resource Types", + "resourceDefinitions": { + "storageSyncServices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Storage Sync Service resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "type": "object", + "properties": {} + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_registeredServers_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices" + }, + "storageSyncServices_registeredServers": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01" + ] + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_cloudEndpoints_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_syncGroups_serverEndpoints_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersPropertiesModelModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersPropertiesModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "ServerEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "definitions": { + "CloudEndpointCreateParametersPropertiesModelModel": { + "type": "object", + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "storageAccountShareName": { + "type": "string", + "description": "Storage Account Share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + } + }, + "description": "CloudEndpoint Properties object." + }, + "RegisteredServerCreateParametersProperties": { + "type": "object", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + } + } + }, + "ServerEndpointCreateParametersPropertiesModel": { + "type": "object", + "properties": { + "serverLocalPath": { + "type": "string", + "description": "Server folder used for data synchronization" + }, + "cloudTiering": { + "oneOf": [ + { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "tierFilesOlderThanDays": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 2147483647 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tier files older than days." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "serverResourceId": { + "type": "string", + "description": "Arm resource identifier." + } + }, + "description": "ServerEndpoint Properties object." + }, + "storageSyncServices_registeredServers_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01" + ] + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersPropertiesModelModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-07-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersPropertiesModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "ServerEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } +} diff --git a/test/Resource/Expected/Microsoft.StorageSync/2018-10-01/Microsoft.StorageSync.json b/test/Resource/Expected/Microsoft.StorageSync/2018-10-01/Microsoft.StorageSync.json new file mode 100644 index 0000000..5abff50 --- /dev/null +++ b/test/Resource/Expected/Microsoft.StorageSync/2018-10-01/Microsoft.StorageSync.json @@ -0,0 +1,520 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.StorageSync.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.StorageSync", + "description": "Microsoft StorageSync Resource Types", + "resourceDefinitions": { + "storageSyncServices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Storage Sync Service resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "type": "object", + "properties": {} + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_registeredServers_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices" + }, + "storageSyncServices_registeredServers": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_cloudEndpoints_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_syncGroups_serverEndpoints_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersPropertiesModelModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "definitions": { + "CloudEndpointCreateParametersPropertiesModelModel": { + "type": "object", + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "storageAccountShareName": { + "type": "string", + "description": "Storage Account Share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + } + }, + "description": "CloudEndpoint Properties object." + }, + "RegisteredServerCreateParametersProperties": { + "type": "object", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + } + } + }, + "ServerEndpointCreateParametersProperties": { + "type": "object", + "properties": { + "serverLocalPath": { + "type": "string", + "description": "Server folder used for data synchronization" + }, + "cloudTiering": { + "oneOf": [ + { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "tierFilesOlderThanDays": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 2147483647 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tier files older than days." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "serverResourceId": { + "type": "string", + "description": "Arm resource identifier." + }, + "offlineDataTransfer": { + "oneOf": [ + { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Offline data transfer." + }, + "offlineDataTransferShareName": { + "type": "string", + "description": "Offline data transfer share name" + } + } + }, + "storageSyncServices_registeredServers_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersPropertiesModelModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } +} diff --git a/test/Resource/Expected/Microsoft.StorageSync/2019-02-01/Microsoft.StorageSync.json b/test/Resource/Expected/Microsoft.StorageSync/2019-02-01/Microsoft.StorageSync.json new file mode 100644 index 0000000..281d857 --- /dev/null +++ b/test/Resource/Expected/Microsoft.StorageSync/2019-02-01/Microsoft.StorageSync.json @@ -0,0 +1,520 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-02-01/Microsoft.StorageSync.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.StorageSync", + "description": "Microsoft StorageSync Resource Types", + "resourceDefinitions": { + "storageSyncServices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Storage Sync Service resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-02-01" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "type": "object", + "properties": {} + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_registeredServers_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices" + }, + "storageSyncServices_registeredServers": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-02-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-02-01" + ] + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_cloudEndpoints_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_syncGroups_serverEndpoints_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-02-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersPropertiesModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-02-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "definitions": { + "CloudEndpointCreateParametersPropertiesModel": { + "type": "object", + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "azureFileShareName": { + "type": "string", + "description": "Azure file share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + } + }, + "description": "CloudEndpoint Properties object." + }, + "RegisteredServerCreateParametersProperties": { + "type": "object", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + } + } + }, + "ServerEndpointCreateParametersProperties": { + "type": "object", + "properties": { + "serverLocalPath": { + "type": "string", + "description": "Server folder used for data synchronization" + }, + "cloudTiering": { + "oneOf": [ + { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "tierFilesOlderThanDays": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 2147483647 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tier files older than days." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "serverResourceId": { + "type": "string", + "description": "Arm resource identifier." + }, + "offlineDataTransfer": { + "oneOf": [ + { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Offline data transfer." + }, + "offlineDataTransferShareName": { + "type": "string", + "description": "Offline data transfer share name" + } + } + }, + "storageSyncServices_registeredServers_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-02-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-02-01" + ] + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-02-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersPropertiesModel" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "CloudEndpoint Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-02-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } +} diff --git a/test/Resource/Expected/Microsoft.StorageSync/2019-03-01/Microsoft.StorageSync.json b/test/Resource/Expected/Microsoft.StorageSync/2019-03-01/Microsoft.StorageSync.json new file mode 100644 index 0000000..ec577d6 --- /dev/null +++ b/test/Resource/Expected/Microsoft.StorageSync/2019-03-01/Microsoft.StorageSync.json @@ -0,0 +1,521 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.StorageSync.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.StorageSync", + "description": "Microsoft StorageSync Resource Types", + "resourceDefinitions": { + "storageSyncServices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Storage Sync Service resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "properties": { + "type": "object", + "properties": {} + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_registeredServers_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "location", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices" + }, + "storageSyncServices_registeredServers": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/storageSyncServices_syncGroups_cloudEndpoints_childResource" + }, + { + "$ref": "#/definitions/storageSyncServices_syncGroups_serverEndpoints_childResource" + } + ] + } + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "definitions": { + "CloudEndpointCreateParametersProperties": { + "type": "object", + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "azureFileShareName": { + "type": "string", + "description": "Azure file share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + } + } + }, + "RegisteredServerCreateParametersProperties": { + "type": "object", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + } + } + }, + "ServerEndpointCreateParametersProperties": { + "type": "object", + "properties": { + "serverLocalPath": { + "type": "string", + "description": "Server folder used for data synchronization" + }, + "cloudTiering": { + "oneOf": [ + { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "tierFilesOlderThanDays": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 2147483647 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Tier files older than days." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "serverResourceId": { + "type": "string", + "description": "Arm resource identifier." + }, + "offlineDataTransfer": { + "oneOf": [ + { + "type": "string", + "enum": [ + "on", + "off" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Offline data transfer." + }, + "offlineDataTransferShareName": { + "type": "string", + "description": "Offline data transfer share name" + } + } + }, + "storageSyncServices_registeredServers_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "GUID identifying the on-premises server." + }, + "type": { + "type": "string", + "enum": [ + "registeredServers" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/RegisteredServerCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "storageSyncServices_syncGroups_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Sync Group resource." + }, + "type": { + "type": "string", + "enum": [ + "syncGroups" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "type": "object", + "properties": {}, + "description": "Sync Group Create Properties object." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }, + "storageSyncServices_syncGroups_cloudEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Cloud Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "cloudEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/CloudEndpointCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + }, + "storageSyncServices_syncGroups_serverEndpoints_childResource": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of Server Endpoint object." + }, + "type": { + "type": "string", + "enum": [ + "serverEndpoints" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ServerEndpointCreateParametersProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } +} diff --git a/test/Resource/Expected/Microsoft.WindowsIoT/2018-02-16-preview/Microsoft.WindowsIoT.json b/test/Resource/Expected/Microsoft.WindowsIoT/2018-02-16-preview/Microsoft.WindowsIoT.json new file mode 100644 index 0000000..930bfbb --- /dev/null +++ b/test/Resource/Expected/Microsoft.WindowsIoT/2018-02-16-preview/Microsoft.WindowsIoT.json @@ -0,0 +1,97 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-02-16-preview/Microsoft.WindowsIoT.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.WindowsIoT", + "description": "Microsoft WindowsIoT Resource Types", + "resourceDefinitions": { + "deviceServices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Windows IoT Device Service." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.WindowsIoT/deviceServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2018-02-16-preview" + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The Azure Region where the resource lives" + }, + "etag": { + "type": "string", + "description": "The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DeviceServiceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties of a Windows IoT Device Service." + } + }, + "required": [ + "name", + "type", + "apiVersion", + "properties" + ], + "description": "Microsoft.WindowsIoT/deviceServices" + } + }, + "definitions": { + "DeviceServiceProperties": { + "type": "object", + "properties": { + "notes": { + "type": "string", + "description": "Windows IoT Device Service notes." + }, + "quantity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Windows IoT Device Service device allocation," + }, + "adminDomainName": { + "type": "string", + "description": "Windows IoT Device Service OEM AAD domain" + } + }, + "description": "The properties of a Windows IoT Device Service." + } + } +} diff --git a/test/Resource/Expected/Microsoft.WindowsIoT/2019-06-01/Microsoft.WindowsIoT.json b/test/Resource/Expected/Microsoft.WindowsIoT/2019-06-01/Microsoft.WindowsIoT.json new file mode 100644 index 0000000..9cbc671 --- /dev/null +++ b/test/Resource/Expected/Microsoft.WindowsIoT/2019-06-01/Microsoft.WindowsIoT.json @@ -0,0 +1,59 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-06-01/Microsoft.WindowsIoT.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.WindowsIoT", + "description": "Microsoft WindowsIoT Resource Types", + "resourceDefinitions": { + "deviceServices": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Windows IoT Device Service." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.WindowsIoT/deviceServices" + ] + }, + "apiVersion": { + "type": "string", + "enum": [ + "2019-06-01" + ] + }, + "notes": { + "type": "string", + "description": "Windows IoT Device Service notes." + }, + "quantity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Windows IoT Device Service device allocation," + }, + "billingDomainName": { + "type": "string", + "description": "Windows IoT Device Service ODM AAD domain" + }, + "adminDomainName": { + "type": "string", + "description": "Windows IoT Device Service OEM AAD domain" + } + }, + "required": [ + "name", + "type", + "apiVersion" + ], + "description": "Microsoft.WindowsIoT/deviceServices" + } + }, + "definitions": {} +} diff --git a/test/Resource/Expected/Monitor/2015-04-01/autoscalesettings.md b/test/Resource/Expected/Monitor/2015-04-01/autoscalesettings.md deleted file mode 100644 index a23a86b..0000000 --- a/test/Resource/Expected/Monitor/2015-04-01/autoscalesettings.md +++ /dev/null @@ -1,219 +0,0 @@ -# microsoft.insights/autoscalesettings template reference -API Version: 2015-04-01 -## Template format - -To create a microsoft.insights/autoscalesettings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "microsoft.insights/autoscalesettings", - "apiVersion": "2015-04-01", - "location": "string", - "tags": {}, - "properties": { - "profiles": [ - { - "name": "string", - "capacity": { - "minimum": "string", - "maximum": "string", - "default": "string" - }, - "rules": [ - { - "metricTrigger": { - "metricName": "string", - "metricResourceUri": "string", - "timeGrain": "string", - "statistic": "string", - "timeWindow": "string", - "timeAggregation": "string", - "operator": "string", - "threshold": "number" - }, - "scaleAction": { - "direction": "string", - "type": "string", - "value": "string", - "cooldown": "string" - } - } - ], - "fixedDate": { - "timeZone": "string", - "start": "string", - "end": "string" - }, - "recurrence": { - "frequency": "string", - "schedule": { - "timeZone": "string", - "days": [ - "string" - ], - "hours": [ - "integer" - ], - "minutes": [ - "integer" - ] - } - } - } - ], - "notifications": [ - { - "operation": "Scale", - "email": { - "sendToSubscriptionAdministrator": "boolean", - "sendToSubscriptionCoAdministrators": "boolean", - "customEmails": [ - "string" - ] - }, - "webhooks": [ - { - "serviceUri": "string", - "properties": {} - } - ] - } - ], - "enabled": "boolean", - "name": "string", - "targetResourceUri": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### microsoft.insights/autoscalesettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The autoscale setting name. | -| type | enum | Yes | microsoft.insights/autoscalesettings | -| apiVersion | enum | Yes | 2015-04-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | The autoscale setting of the resource. - [AutoscaleSetting object](#AutoscaleSetting) | - - - -### AutoscaleSetting object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| profiles | array | Yes | the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. - [AutoscaleProfile object](#AutoscaleProfile) | -| notifications | array | No | the collection of notifications. - [AutoscaleNotification object](#AutoscaleNotification) | -| enabled | boolean | No | the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'. | -| name | string | No | the name of the autoscale setting. | -| targetResourceUri | string | No | the resource identifier of the resource that the autoscale setting should be added to. | - - - -### AutoscaleProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | the name of the profile. | -| capacity | object | Yes | the number of instances that can be used during this profile. - [ScaleCapacity object](#ScaleCapacity) | -| rules | array | Yes | the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. - [ScaleRule object](#ScaleRule) | -| fixedDate | object | No | the specific date-time for the profile. This element is not used if the Recurrence element is used. - [TimeWindow object](#TimeWindow) | -| recurrence | object | No | the repeating times at which this profile begins. This element is not used if the FixedDate element is used. - [Recurrence object](#Recurrence) | - - - -### AutoscaleNotification object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| operation | enum | Yes | the operation associated with the notification and its value must be "scale" - Scale | -| email | object | No | the email notification. - [EmailNotification object](#EmailNotification) | -| webhooks | array | No | the collection of webhook notifications. - [WebhookNotification object](#WebhookNotification) | - - - -### ScaleCapacity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| minimum | string | Yes | the minimum number of instances for the resource. | -| maximum | string | Yes | 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. | -| default | string | Yes | 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. | - - - -### ScaleRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| metricTrigger | object | Yes | the trigger that results in a scaling action. - [MetricTrigger object](#MetricTrigger) | -| scaleAction | object | Yes | the parameters for the scaling action. - [ScaleAction object](#ScaleAction) | - - - -### TimeWindow object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| timeZone | string | No | the timezone of the start and end times for the profile. Some examples of valid timezones 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 | -| start | string | Yes | the start time for the profile in ISO 8601 format. | -| end | string | Yes | the end time for the profile in ISO 8601 format. | - - - -### Recurrence object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frequency | enum | Yes | 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. - None, Second, Minute, Hour, Day, Week, Month, Year | -| schedule | object | Yes | the scheduling constraints for when the profile begins. - [RecurrentSchedule object](#RecurrentSchedule) | - - - -### EmailNotification object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sendToSubscriptionAdministrator | boolean | No | a value indicating whether to send email to subscription administrator. | -| sendToSubscriptionCoAdministrators | boolean | No | a value indicating whether to send email to subscription co-administrators. | -| customEmails | array | No | the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. - string | - - - -### WebhookNotification object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceUri | string | No | the service address to receive the notification. | -| properties | object | No | a property bag of settings. This value can be empty. | - - - -### MetricTrigger object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| metricName | string | Yes | the name of the metric that defines what the rule monitors. | -| metricResourceUri | string | Yes | the resource identifier of the resource the rule monitors. | -| timeGrain | string | Yes | 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. | -| statistic | enum | Yes | the metric statistic type. How the metrics from multiple instances are combined. - Average, Min, Max, Sum | -| timeWindow | string | Yes | 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. | -| timeAggregation | enum | Yes | time aggregation type. How the data that is collected should be combined over time. The default value is Average. - Average, Minimum, Maximum, Total, Count | -| operator | enum | Yes | the operator that is used to compare the metric data and the threshold. - Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual | -| threshold | number | Yes | the threshold of the metric that triggers the scale action. | - - - -### ScaleAction object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| direction | enum | Yes | the scale direction. Whether the scaling action increases or decreases the number of instances. - None, Increase, Decrease | -| type | enum | Yes | the type of action that should occur when the scale rule fires. - ChangeCount, PercentChangeCount, ExactCount | -| value | string | No | the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. | -| cooldown | string | Yes | 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. | - - - -### RecurrentSchedule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| timeZone | string | Yes | the timezone for the hours of the profile. Some examples of valid timezones 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 | -| days | array | Yes | the collection of days that the profile takes effect on. Possible values are Sunday through Saturday. - string | -| hours | array | Yes | 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). - integer | -| minutes | array | Yes | A collection of minutes at which the profile takes effect at. - integer | - diff --git a/test/Resource/Expected/Monitor/2015-04-01/microsoft.insights.json b/test/Resource/Expected/Monitor/2015-04-01/microsoft.insights.json deleted file mode 100644 index 57c8770..0000000 --- a/test/Resource/Expected/Monitor/2015-04-01/microsoft.insights.json +++ /dev/null @@ -1,634 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-04-01/microsoft.insights.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "microsoft.insights", - "description": "microsoft insights Resource Types", - "resourceDefinitions": { - "autoscalesettings": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The autoscale setting name." - }, - "type": { - "type": "string", - "enum": [ - "microsoft.insights/autoscalesettings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-04-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AutoscaleSetting" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The autoscale setting of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "microsoft.insights/autoscalesettings" - } - }, - "definitions": { - "AutoscaleNotification": { - "type": "object", - "properties": { - "operation": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Scale" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the operation associated with the notification and its value must be \"scale\"" - }, - "email": { - "oneOf": [ - { - "$ref": "#/definitions/EmailNotification" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the email notification." - }, - "webhooks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/WebhookNotification" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the collection of webhook notifications." - } - }, - "required": [ - "operation" - ], - "description": "Autoscale notification." - }, - "AutoscaleProfile": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "the name of the profile." - }, - "capacity": { - "oneOf": [ - { - "$ref": "#/definitions/ScaleCapacity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the number of instances that can be used during this profile." - }, - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ScaleRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified." - }, - "fixedDate": { - "oneOf": [ - { - "$ref": "#/definitions/TimeWindow" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the specific date-time for the profile. This element is not used if the Recurrence element is used." - }, - "recurrence": { - "oneOf": [ - { - "$ref": "#/definitions/Recurrence" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the repeating times at which this profile begins. This element is not used if the FixedDate element is used." - } - }, - "required": [ - "name", - "capacity", - "rules" - ], - "description": "Autoscale profile." - }, - "AutoscaleSetting": { - "type": "object", - "properties": { - "profiles": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AutoscaleProfile" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified." - }, - "notifications": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AutoscaleNotification" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the collection of notifications." - }, - "enabled": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'." - }, - "name": { - "type": "string", - "description": "the name of the autoscale setting." - }, - "targetResourceUri": { - "type": "string", - "description": "the resource identifier of the resource that the autoscale setting should be added to." - } - }, - "required": [ - "profiles" - ], - "description": "A setting that contains all of the configuration for the automatic scaling of a resource." - }, - "EmailNotification": { - "type": "object", - "properties": { - "sendToSubscriptionAdministrator": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "a value indicating whether to send email to subscription administrator." - }, - "sendToSubscriptionCoAdministrators": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "a value indicating whether to send email to subscription co-administrators." - }, - "customEmails": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored." - } - }, - "description": "Email notification of an autoscale event." - }, - "MetricTrigger": { - "type": "object", - "properties": { - "metricName": { - "type": "string", - "description": "the name of the metric that defines what the rule monitors." - }, - "metricResourceUri": { - "type": "string", - "description": "the resource identifier of the resource the rule monitors." - }, - "timeGrain": { - "type": "string", - "format": "duration", - "description": "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." - }, - "statistic": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Average", - "Min", - "Max", - "Sum" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the metric statistic type. How the metrics from multiple instances are combined." - }, - "timeWindow": { - "type": "string", - "format": "duration", - "description": "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." - }, - "timeAggregation": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Average", - "Minimum", - "Maximum", - "Total", - "Count" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "time aggregation type. How the data that is collected should be combined over time. The default value is Average." - }, - "operator": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Equals", - "NotEquals", - "GreaterThan", - "GreaterThanOrEqual", - "LessThan", - "LessThanOrEqual" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the operator that is used to compare the metric data and the threshold." - }, - "threshold": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the threshold of the metric that triggers the scale action." - } - }, - "required": [ - "metricName", - "metricResourceUri", - "timeGrain", - "statistic", - "timeWindow", - "timeAggregation", - "operator", - "threshold" - ], - "description": "The trigger that results in a scaling action." - }, - "Recurrence": { - "type": "object", - "properties": { - "frequency": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Second", - "Minute", - "Hour", - "Day", - "Week", - "Month", - "Year" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "schedule": { - "oneOf": [ - { - "$ref": "#/definitions/RecurrentSchedule" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the scheduling constraints for when the profile begins." - } - }, - "required": [ - "frequency", - "schedule" - ], - "description": "The repeating times at which this profile begins. This element is not used if the FixedDate element is used." - }, - "RecurrentSchedule": { - "type": "object", - "properties": { - "timeZone": { - "type": "string", - "description": "the timezone for the hours of the profile. Some examples of valid timezones 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" - }, - "days": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the collection of days that the profile takes effect on. Possible values are Sunday through Saturday." - }, - "hours": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of minutes at which the profile takes effect at." - } - }, - "required": [ - "timeZone", - "days", - "hours", - "minutes" - ], - "description": "The scheduling constraints for when the profile begins." - }, - "ScaleAction": { - "type": "object", - "properties": { - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Increase", - "Decrease" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the scale direction. Whether the scaling action increases or decreases the number of instances." - }, - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "ChangeCount", - "PercentChangeCount", - "ExactCount" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the type of action that should occur when the scale rule fires." - }, - "value": { - "type": "string", - "default": "1", - "description": "the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1." - }, - "cooldown": { - "type": "string", - "format": "duration", - "description": "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." - } - }, - "required": [ - "direction", - "type", - "cooldown" - ], - "description": "The parameters for the scaling action." - }, - "ScaleCapacity": { - "type": "object", - "properties": { - "minimum": { - "type": "string", - "description": "the minimum number of instances for the resource." - }, - "maximum": { - "type": "string", - "description": "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." - }, - "default": { - "type": "string", - "description": "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." - } - }, - "required": [ - "minimum", - "maximum", - "default" - ], - "description": "The number of instances that can be used during this profile." - }, - "ScaleRule": { - "type": "object", - "properties": { - "metricTrigger": { - "oneOf": [ - { - "$ref": "#/definitions/MetricTrigger" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the trigger that results in a scaling action." - }, - "scaleAction": { - "oneOf": [ - { - "$ref": "#/definitions/ScaleAction" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the parameters for the scaling action." - } - }, - "required": [ - "metricTrigger", - "scaleAction" - ], - "description": "A rule that provide the triggers and parameters for the scaling action." - }, - "TimeWindow": { - "type": "object", - "properties": { - "timeZone": { - "type": "string", - "description": "the timezone of the start and end times for the profile. Some examples of valid timezones 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" - }, - "start": { - "type": "string", - "format": "date-time", - "description": "the start time for the profile in ISO 8601 format." - }, - "end": { - "type": "string", - "format": "date-time", - "description": "the end time for the profile in ISO 8601 format." - } - }, - "required": [ - "start", - "end" - ], - "description": "A specific date-time for the profile." - }, - "WebhookNotification": { - "type": "object", - "properties": { - "serviceUri": { - "type": "string", - "description": "the service address to receive the notification." - }, - "properties": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "a property bag of settings. This value can be empty." - } - }, - "description": "Webhook notification of an autoscale event." - } - } -} diff --git a/test/Resource/Expected/Monitor/2016-03-01/alertrules.md b/test/Resource/Expected/Monitor/2016-03-01/alertrules.md deleted file mode 100644 index defa238..0000000 --- a/test/Resource/Expected/Monitor/2016-03-01/alertrules.md +++ /dev/null @@ -1,68 +0,0 @@ -# microsoft.insights/alertrules template reference -API Version: 2016-03-01 -## Template format - -To create a microsoft.insights/alertrules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "microsoft.insights/alertrules", - "apiVersion": "2016-03-01", - "location": "string", - "tags": {}, - "properties": { - "name": "string", - "description": "string", - "isEnabled": "boolean", - "condition": { - "dataSource": { - "resourceUri": "string" - } - }, - "actions": [ - {} - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### microsoft.insights/alertrules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the rule. | -| type | enum | Yes | microsoft.insights/alertrules | -| apiVersion | enum | Yes | 2016-03-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | The alert rule properties of the resource. - [AlertRule object](#AlertRule) | - - - -### AlertRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | the name of the alert rule. | -| description | string | No | the description of the alert rule that will be included in the alert email. | -| isEnabled | boolean | Yes | the flag that indicates whether the alert rule is enabled. | -| condition | object | Yes | the condition that results in the alert rule being activated. - [RuleCondition object](#RuleCondition) | -| actions | array | No | the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. - [RuleAction object](#RuleAction) | - - - -### RuleCondition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dataSource | object | No | the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. - [RuleDataSource object](#RuleDataSource) | - - - -### RuleDataSource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| resourceUri | string | No | the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. | - diff --git a/test/Resource/Expected/Monitor/2016-03-01/logprofiles.md b/test/Resource/Expected/Monitor/2016-03-01/logprofiles.md deleted file mode 100644 index 63d00cc..0000000 --- a/test/Resource/Expected/Monitor/2016-03-01/logprofiles.md +++ /dev/null @@ -1,63 +0,0 @@ -# microsoft.insights/logprofiles template reference -API Version: 2016-03-01 -## Template format - -To create a microsoft.insights/logprofiles resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "microsoft.insights/logprofiles", - "apiVersion": "2016-03-01", - "location": "string", - "tags": {}, - "properties": { - "storageAccountId": "string", - "serviceBusRuleId": "string", - "locations": [ - "string" - ], - "categories": [ - "string" - ], - "retentionPolicy": { - "enabled": "boolean", - "days": "integer" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### microsoft.insights/logprofiles object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the log profile. | -| type | enum | Yes | microsoft.insights/logprofiles | -| apiVersion | enum | Yes | 2016-03-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | The log profile properties of the resource. - [LogProfileProperties object](#LogProfileProperties) | - - - -### LogProfileProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountId | string | No | the resource id of the storage account to which you would like to send the Activity Log. | -| serviceBusRuleId | string | No | 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}'. | -| locations | array | Yes | 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. - string | -| categories | array | Yes | the categories of the logs. These categories are created as is convenient to the user. Some values are: 'Write', 'Delete', and/or 'Action.' - string | -| retentionPolicy | object | Yes | the retention policy for the events in the log. - [RetentionPolicy object](#RetentionPolicy) | - - - -### RetentionPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | a value indicating whether the retention policy is enabled. | -| days | integer | Yes | the number of days for the retention in days. A value of 0 will retain the events indefinitely. | - diff --git a/test/Resource/Expected/Monitor/2016-03-01/microsoft.insights.json b/test/Resource/Expected/Monitor/2016-03-01/microsoft.insights.json deleted file mode 100644 index 202d8bb..0000000 --- a/test/Resource/Expected/Monitor/2016-03-01/microsoft.insights.json +++ /dev/null @@ -1,510 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-03-01/microsoft.insights.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "microsoft.insights", - "description": "microsoft insights Resource Types", - "resourceDefinitions": { - "alertrules": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the rule." - }, - "type": { - "type": "string", - "enum": [ - "microsoft.insights/alertrules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AlertRule" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The alert rule properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "microsoft.insights/alertrules" - } - }, - "definitions": { - "AlertRule": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "the name of the alert rule." - }, - "description": { - "type": "string", - "description": "the description of the alert rule that will be included in the alert email." - }, - "isEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the flag that indicates whether the alert rule is enabled." - }, - "condition": { - "oneOf": [ - { - "$ref": "#/definitions/RuleCondition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the condition that results in the alert rule being activated." - }, - "actions": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RuleAction" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved." - } - }, - "required": [ - "name", - "isEnabled", - "condition" - ], - "description": "An alert rule." - }, - "LocationThresholdRuleCondition": { - "type": "object", - "properties": { - "windowSize": { - "type": "string", - "format": "duration", - "description": "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." - }, - "failedLocationCount": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the number of locations that must fail to activate the alert." - }, - "odata.type": { - "type": "string", - "enum": [ - "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition" - ] - } - }, - "required": [ - "failedLocationCount", - "odata.type" - ], - "description": "A rule condition based on a certain number of locations failing." - }, - "ManagementEventAggregationCondition": { - "type": "object", - "properties": { - "operator": { - "oneOf": [ - { - "type": "string", - "enum": [ - "GreaterThan", - "GreaterThanOrEqual", - "LessThan", - "LessThanOrEqual" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the condition operator." - }, - "threshold": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The threshold value that activates the alert." - }, - "windowSize": { - "type": "string", - "format": "duration", - "description": "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." - } - }, - "description": "How the data that is collected should be combined over time." - }, - "ManagementEventRuleCondition": { - "type": "object", - "properties": { - "aggregation": { - "oneOf": [ - { - "$ref": "#/definitions/ManagementEventAggregationCondition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "How the data that is collected should be combined over time and when the alert is activated. Note that for management event alerts aggregation is optional – if it is not provided then any event will cause the alert to activate." - }, - "odata.type": { - "type": "string", - "enum": [ - "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition" - ] - } - }, - "required": [ - "odata.type" - ], - "description": "A management event rule condition." - }, - "RuleAction": { - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/RuleEmailAction" - }, - { - "$ref": "#/definitions/RuleWebhookAction" - } - ], - "properties": {}, - "description": "The action that is performed when the alert rule becomes active, and when an alert condition is resolved." - }, - "RuleCondition": { - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/ThresholdRuleCondition" - }, - { - "$ref": "#/definitions/LocationThresholdRuleCondition" - }, - { - "$ref": "#/definitions/ManagementEventRuleCondition" - } - ], - "properties": { - "dataSource": { - "oneOf": [ - { - "$ref": "#/definitions/RuleDataSource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource." - } - }, - "description": "The condition that results in the alert rule being activated." - }, - "RuleDataSource": { - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/RuleMetricDataSource" - }, - { - "$ref": "#/definitions/RuleManagementEventDataSource" - } - ], - "properties": { - "resourceUri": { - "type": "string", - "description": "the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule." - } - }, - "description": "The resource from which the rule collects its data." - }, - "RuleEmailAction": { - "type": "object", - "properties": { - "sendToServiceOwners": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the administrators (service and co-administrators) of the service should be notified when the alert is activated." - }, - "customEmails": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the list of administrator's custom email addresses to notify of the activation of the alert." - }, - "odata.type": { - "type": "string", - "enum": [ - "Microsoft.Azure.Management.Insights.Models.RuleEmailAction" - ] - } - }, - "required": [ - "odata.type" - ], - "description": "Specifies the action to send email when the rule condition is evaluated. The discriminator is always RuleEmailAction in this case." - }, - "RuleManagementEventClaimsDataSource": { - "type": "object", - "properties": { - "emailAddress": { - "type": "string", - "description": "the email address." - } - }, - "description": "The claims for a rule management event data source." - }, - "RuleManagementEventDataSource": { - "type": "object", - "properties": { - "eventName": { - "type": "string", - "description": "the event name." - }, - "eventSource": { - "type": "string", - "description": "the event source." - }, - "level": { - "type": "string", - "description": "the level." - }, - "operationName": { - "type": "string", - "description": "The name of the operation that should be checked for. If no name is provided, any operation will match." - }, - "resourceGroupName": { - "type": "string", - "description": "the resource group name." - }, - "resourceProviderName": { - "type": "string", - "description": "the resource provider name." - }, - "status": { - "type": "string", - "description": "The status of the operation that should be checked for. If no status is provided, any status will match." - }, - "subStatus": { - "type": "string", - "description": "the substatus." - }, - "claims": { - "oneOf": [ - { - "$ref": "#/definitions/RuleManagementEventClaimsDataSource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the claims." - }, - "odata.type": { - "type": "string", - "enum": [ - "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource" - ] - } - }, - "required": [ - "odata.type" - ], - "description": "A rule management event data source. The discriminator fields is always RuleManagementEventDataSource in this case." - }, - "RuleMetricDataSource": { - "type": "object", - "properties": { - "metricName": { - "type": "string", - "description": "the name of the metric that defines what the rule monitors." - }, - "odata.type": { - "type": "string", - "enum": [ - "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource" - ] - } - }, - "required": [ - "odata.type" - ], - "description": "A rule metric data source. The discriminator value is always RuleMetricDataSource in this case." - }, - "RuleWebhookAction": { - "type": "object", - "properties": { - "serviceUri": { - "type": "string", - "description": "the service uri to Post the notification when the alert activates or resolves." - }, - "properties": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload." - }, - "odata.type": { - "type": "string", - "enum": [ - "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction" - ] - } - }, - "required": [ - "odata.type" - ], - "description": "Specifies the action to post to service when the rule condition is evaluated. The discriminator is always RuleWebhookAction in this case." - }, - "ThresholdRuleCondition": { - "type": "object", - "properties": { - "operator": { - "oneOf": [ - { - "type": "string", - "enum": [ - "GreaterThan", - "GreaterThanOrEqual", - "LessThan", - "LessThanOrEqual" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the operator used to compare the data and the threshold." - }, - "threshold": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the threshold value that activates the alert." - }, - "windowSize": { - "type": "string", - "format": "duration", - "description": "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." - }, - "timeAggregation": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Average", - "Minimum", - "Maximum", - "Total", - "Last" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric." - }, - "odata.type": { - "type": "string", - "enum": [ - "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition" - ] - } - }, - "required": [ - "operator", - "threshold", - "odata.type" - ], - "description": "A rule condition based on a metric crossing a threshold." - } - } -} diff --git a/test/Resource/Expected/Monitor/2017-04-01/actionGroups.md b/test/Resource/Expected/Monitor/2017-04-01/actionGroups.md deleted file mode 100644 index 4660a1c..0000000 --- a/test/Resource/Expected/Monitor/2017-04-01/actionGroups.md +++ /dev/null @@ -1,148 +0,0 @@ -# microsoft.insights/actionGroups template reference -API Version: 2017-04-01 -## Template format - -To create a microsoft.insights/actionGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "microsoft.insights/actionGroups", - "apiVersion": "2017-04-01", - "location": "string", - "tags": {}, - "properties": { - "groupShortName": "string", - "enabled": "boolean", - "emailReceivers": [ - { - "name": "string", - "emailAddress": "string" - } - ], - "smsReceivers": [ - { - "name": "string", - "countryCode": "string", - "phoneNumber": "string" - } - ], - "webhookReceivers": [ - { - "name": "string", - "serviceUri": "string" - } - ], - "itsmReceivers": [ - { - "name": "string", - "workspaceId": "string", - "connectionId": "string", - "ticketConfiguration": "string", - "region": "string" - } - ], - "azureAppPushReceivers": [ - { - "name": "string", - "emailAddress": "string" - } - ], - "automationRunbookReceivers": [ - { - "automationAccountId": "string", - "runbookName": "string", - "webhookResourceId": "string", - "isGlobalRunbook": "boolean", - "name": "string", - "serviceUri": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### microsoft.insights/actionGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the action group. | -| type | enum | Yes | microsoft.insights/actionGroups | -| apiVersion | enum | Yes | 2017-04-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | The action groups properties of the resource. - [ActionGroup object](#ActionGroup) | - - - -### ActionGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| groupShortName | string | Yes | The short name of the action group. This will be used in SMS messages. | -| enabled | boolean | Yes | Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. | -| emailReceivers | array | No | The list of email receivers that are part of this action group. - [EmailReceiver object](#EmailReceiver) | -| smsReceivers | array | No | The list of SMS receivers that are part of this action group. - [SmsReceiver object](#SmsReceiver) | -| webhookReceivers | array | No | The list of webhook receivers that are part of this action group. - [WebhookReceiver object](#WebhookReceiver) | -| itsmReceivers | array | No | The list of ITSM receivers that are part of this action group. - [ItsmReceiver object](#ItsmReceiver) | -| azureAppPushReceivers | array | No | The list of AzureAppPush receivers that are part of this action group. - [AzureAppPushReceiver object](#AzureAppPushReceiver) | -| automationRunbookReceivers | array | No | The list of AutomationRunbook receivers that are part of this action group. - [AutomationRunbookReceiver object](#AutomationRunbookReceiver) | - - - -### EmailReceiver object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the email receiver. Names must be unique across all receivers within an action group. | -| emailAddress | string | Yes | The email address of this receiver. | - - - -### SmsReceiver object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the SMS receiver. Names must be unique across all receivers within an action group. | -| countryCode | string | Yes | The country code of the SMS receiver. | -| phoneNumber | string | Yes | The phone number of the SMS receiver. | - - - -### WebhookReceiver object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the webhook receiver. Names must be unique across all receivers within an action group. | -| serviceUri | string | Yes | The URI where webhooks should be sent. | - - - -### ItsmReceiver object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the Itsm receiver. Names must be unique across all receivers within an action group. | -| workspaceId | string | Yes | OMS LA instance identifier. | -| connectionId | string | Yes | Unique identification of ITSM connection among multiple defined in above workspace. | -| ticketConfiguration | string | Yes | JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well. | -| region | string | Yes | Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' | - - - -### AzureAppPushReceiver object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group. | -| emailAddress | string | Yes | The email address registered for the Azure mobile app. | - - - -### AutomationRunbookReceiver object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| automationAccountId | string | Yes | The Azure automation account Id which holds this runbook and authenticate to Azure resource. | -| runbookName | string | Yes | The name for this runbook. | -| webhookResourceId | string | Yes | The resource id for webhook linked to this runbook. | -| isGlobalRunbook | boolean | Yes | Indicates whether this instance is global runbook. | -| name | string | No | Indicates name of the webhook. | -| serviceUri | string | No | The URI where webhooks should be sent. | - diff --git a/test/Resource/Expected/Monitor/2017-04-01/activityLogAlerts.md b/test/Resource/Expected/Monitor/2017-04-01/activityLogAlerts.md deleted file mode 100644 index a5cb45c..0000000 --- a/test/Resource/Expected/Monitor/2017-04-01/activityLogAlerts.md +++ /dev/null @@ -1,94 +0,0 @@ -# microsoft.insights/activityLogAlerts template reference -API Version: 2017-04-01 -## Template format - -To create a microsoft.insights/activityLogAlerts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "microsoft.insights/activityLogAlerts", - "apiVersion": "2017-04-01", - "location": "string", - "tags": {}, - "properties": { - "scopes": [ - "string" - ], - "enabled": "boolean", - "condition": { - "allOf": [ - { - "field": "string", - "equals": "string" - } - ] - }, - "actions": { - "actionGroups": [ - { - "actionGroupId": "string", - "webhookProperties": {} - } - ] - }, - "description": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### microsoft.insights/activityLogAlerts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the activity log alert. | -| type | enum | Yes | microsoft.insights/activityLogAlerts | -| apiVersion | enum | Yes | 2017-04-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | The activity log alert properties of the resource. - [ActivityLogAlert object](#ActivityLogAlert) | - - - -### ActivityLogAlert object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| scopes | array | Yes | 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. - string | -| enabled | boolean | No | Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. | -| condition | object | Yes | The condition that will cause this alert to activate. - [ActivityLogAlertAllOfCondition object](#ActivityLogAlertAllOfCondition) | -| actions | object | Yes | The actions that will activate when the condition is met. - [ActivityLogAlertActionList object](#ActivityLogAlertActionList) | -| description | string | No | A description of this activity log alert. | - - - -### ActivityLogAlertAllOfCondition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allOf | array | Yes | The list of activity log alert conditions. - [ActivityLogAlertLeafCondition object](#ActivityLogAlertLeafCondition) | - - - -### ActivityLogAlertActionList object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| actionGroups | array | No | The list of activity log alerts. - [ActivityLogAlertActionGroup object](#ActivityLogAlertActionGroup) | - - - -### ActivityLogAlertLeafCondition object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| field | string | Yes | 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.'. | -| equals | string | Yes | The field value will be compared to this value (case-insensitive) to determine if the condition is met. | - - - -### ActivityLogAlertActionGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| actionGroupId | string | Yes | The resourceId of the action group. This cannot be null or empty. | -| webhookProperties | object | No | the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. | - diff --git a/test/Resource/Expected/Monitor/2017-04-01/microsoft.insights.json b/test/Resource/Expected/Monitor/2017-04-01/microsoft.insights.json deleted file mode 100644 index 28b34ad..0000000 --- a/test/Resource/Expected/Monitor/2017-04-01/microsoft.insights.json +++ /dev/null @@ -1,544 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-04-01/microsoft.insights.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "microsoft.insights", - "description": "microsoft insights Resource Types", - "resourceDefinitions": { - "actionGroups": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the action group." - }, - "type": { - "type": "string", - "enum": [ - "microsoft.insights/actionGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ActionGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The action groups properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "microsoft.insights/actionGroups" - }, - "activityLogAlerts": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the activity log alert." - }, - "type": { - "type": "string", - "enum": [ - "microsoft.insights/activityLogAlerts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-04-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ActivityLogAlert" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The activity log alert properties of the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "microsoft.insights/activityLogAlerts" - } - }, - "definitions": { - "ActionGroup": { - "type": "object", - "properties": { - "groupShortName": { - "type": "string", - "maxLength": 15, - "description": "The short name of the action group. This will be used in SMS messages." - }, - "enabled": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications." - }, - "emailReceivers": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/EmailReceiver" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of email receivers that are part of this action group." - }, - "smsReceivers": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SmsReceiver" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of SMS receivers that are part of this action group." - }, - "webhookReceivers": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/WebhookReceiver" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of webhook receivers that are part of this action group." - }, - "itsmReceivers": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ItsmReceiver" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of ITSM receivers that are part of this action group." - }, - "azureAppPushReceivers": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AzureAppPushReceiver" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of AzureAppPush receivers that are part of this action group." - }, - "automationRunbookReceivers": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/AutomationRunbookReceiver" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of AutomationRunbook receivers that are part of this action group." - } - }, - "required": [ - "groupShortName", - "enabled" - ], - "description": "An Azure action group." - }, - "ActivityLogAlert": { - "type": "object", - "properties": { - "scopes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "enabled": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated." - }, - "condition": { - "oneOf": [ - { - "$ref": "#/definitions/ActivityLogAlertAllOfCondition" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The condition that will cause this alert to activate." - }, - "actions": { - "oneOf": [ - { - "$ref": "#/definitions/ActivityLogAlertActionList" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The actions that will activate when the condition is met." - }, - "description": { - "type": "string", - "description": "A description of this activity log alert." - } - }, - "required": [ - "scopes", - "condition", - "actions" - ], - "description": "An Azure activity log alert." - }, - "ActivityLogAlertActionGroup": { - "type": "object", - "properties": { - "actionGroupId": { - "type": "string", - "description": "The resourceId of the action group. This cannot be null or empty." - }, - "webhookProperties": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload." - } - }, - "required": [ - "actionGroupId" - ], - "description": "A pointer to an Azure Action Group." - }, - "ActivityLogAlertActionList": { - "type": "object", - "properties": { - "actionGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ActivityLogAlertActionGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of activity log alerts." - } - }, - "description": "A list of activity log alert actions." - }, - "ActivityLogAlertAllOfCondition": { - "type": "object", - "properties": { - "allOf": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ActivityLogAlertLeafCondition" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of activity log alert conditions." - } - }, - "required": [ - "allOf" - ], - "description": "An Activity Log alert condition that is met when all its member conditions are met." - }, - "ActivityLogAlertLeafCondition": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "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.'." - }, - "equals": { - "type": "string", - "description": "The field value will be compared to this value (case-insensitive) to determine if the condition is met." - } - }, - "required": [ - "field", - "equals" - ], - "description": "An Activity Log alert condition that is met by comparing an activity log field and value." - }, - "AutomationRunbookReceiver": { - "type": "object", - "properties": { - "automationAccountId": { - "type": "string", - "description": "The Azure automation account Id which holds this runbook and authenticate to Azure resource." - }, - "runbookName": { - "type": "string", - "description": "The name for this runbook." - }, - "webhookResourceId": { - "type": "string", - "description": "The resource id for webhook linked to this runbook." - }, - "isGlobalRunbook": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether this instance is global runbook." - }, - "name": { - "type": "string", - "description": "Indicates name of the webhook." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - } - }, - "required": [ - "automationAccountId", - "runbookName", - "webhookResourceId", - "isGlobalRunbook" - ], - "description": "The Azure Automation Runbook notification receiver." - }, - "AzureAppPushReceiver": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address registered for the Azure mobile app." - } - }, - "required": [ - "name", - "emailAddress" - ], - "description": "The Azure mobile App push notification receiver." - }, - "EmailReceiver": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the email receiver. Names must be unique across all receivers within an action group." - }, - "emailAddress": { - "type": "string", - "description": "The email address of this receiver." - } - }, - "required": [ - "name", - "emailAddress" - ], - "description": "An email receiver." - }, - "ItsmReceiver": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the Itsm receiver. Names must be unique across all receivers within an action group." - }, - "workspaceId": { - "type": "string", - "description": "OMS LA instance identifier." - }, - "connectionId": { - "type": "string", - "description": "Unique identification of ITSM connection among multiple defined in above workspace." - }, - "ticketConfiguration": { - "type": "string", - "description": "JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well." - }, - "region": { - "type": "string", - "description": "Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'" - } - }, - "required": [ - "name", - "workspaceId", - "connectionId", - "ticketConfiguration", - "region" - ], - "description": "An Itsm receiver." - }, - "SmsReceiver": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SMS receiver. Names must be unique across all receivers within an action group." - }, - "countryCode": { - "type": "string", - "description": "The country code of the SMS receiver." - }, - "phoneNumber": { - "type": "string", - "description": "The phone number of the SMS receiver." - } - }, - "required": [ - "name", - "countryCode", - "phoneNumber" - ], - "description": "An SMS receiver." - }, - "WebhookReceiver": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the webhook receiver. Names must be unique across all receivers within an action group." - }, - "serviceUri": { - "type": "string", - "description": "The URI where webhooks should be sent." - } - }, - "required": [ - "name", - "serviceUri" - ], - "description": "A webhook receiver." - } - } -} diff --git a/test/Resource/Expected/Monitor/2017-05-01-preview/diagnosticSettings.md b/test/Resource/Expected/Monitor/2017-05-01-preview/diagnosticSettings.md deleted file mode 100644 index 93fe674..0000000 --- a/test/Resource/Expected/Monitor/2017-05-01-preview/diagnosticSettings.md +++ /dev/null @@ -1,92 +0,0 @@ -# microsoft.insights/diagnosticSettings template reference -API Version: 2017-05-01-preview -## Template format - -To create a microsoft.insights/diagnosticSettings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "microsoft.insights/diagnosticSettings", - "apiVersion": "2017-05-01-preview", - "properties": { - "storageAccountId": "string", - "eventHubAuthorizationRuleId": "string", - "eventHubName": "string", - "metrics": [ - { - "timeGrain": "string", - "category": "string", - "enabled": "boolean", - "retentionPolicy": { - "enabled": "boolean", - "days": "integer" - } - } - ], - "logs": [ - { - "category": "string", - "enabled": "boolean", - "retentionPolicy": { - "enabled": "boolean", - "days": "integer" - } - } - ], - "workspaceId": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### microsoft.insights/diagnosticSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the diagnostic setting. | -| type | enum | Yes | microsoft.insights/diagnosticSettings | -| apiVersion | enum | Yes | 2017-05-01-preview | -| properties | object | Yes | [DiagnosticSettings object](#DiagnosticSettings) | - - - -### DiagnosticSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountId | string | No | The resource ID of the storage account to which you would like to send Diagnostic Logs. | -| eventHubAuthorizationRuleId | string | No | The resource Id for the event hub authorization rule. | -| eventHubName | string | No | The name of the event hub. If none is specified, the default event hub will be selected. | -| metrics | array | No | the list of metric settings. - [MetricSettings object](#MetricSettings) | -| logs | array | No | the list of logs settings. - [LogSettings object](#LogSettings) | -| workspaceId | string | No | 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 | - - - -### MetricSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| timeGrain | string | No | the timegrain of the metric in ISO8601 format. | -| category | string | No | 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 | boolean | Yes | a value indicating whether this category is enabled. | -| retentionPolicy | object | No | the retention policy for this category. - [RetentionPolicy object](#RetentionPolicy) | - - - -### LogSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| category | string | No | 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 | boolean | Yes | a value indicating whether this log is enabled. | -| retentionPolicy | object | No | the retention policy for this log. - [RetentionPolicy object](#RetentionPolicy) | - - - -### RetentionPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | a value indicating whether the retention policy is enabled. | -| days | integer | Yes | the number of days for the retention in days. A value of 0 will retain the events indefinitely. | - diff --git a/test/Resource/Expected/Monitor/2017-05-01-preview/microsoft.insights.json b/test/Resource/Expected/Monitor/2017-05-01-preview/microsoft.insights.json deleted file mode 100644 index b4faed8..0000000 --- a/test/Resource/Expected/Monitor/2017-05-01-preview/microsoft.insights.json +++ /dev/null @@ -1,206 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-05-01-preview/microsoft.insights.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "microsoft.insights", - "description": "microsoft insights Resource Types", - "resourceDefinitions": { - "diagnosticSettings": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the diagnostic setting." - }, - "type": { - "type": "string", - "enum": [ - "microsoft.insights/diagnosticSettings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-05-01-preview" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "microsoft.insights/diagnosticSettings" - } - }, - "definitions": { - "DiagnosticSettings": { - "type": "object", - "properties": { - "storageAccountId": { - "type": "string", - "description": "The resource ID of the storage account to which you would like to send Diagnostic Logs." - }, - "eventHubAuthorizationRuleId": { - "type": "string", - "description": "The resource Id for the event hub authorization rule." - }, - "eventHubName": { - "type": "string", - "description": "The name of the event hub. If none is specified, the default event hub will be selected." - }, - "metrics": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/MetricSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the list of metric settings." - }, - "logs": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LogSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the list of logs settings." - }, - "workspaceId": { - "type": "string", - "description": "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" - } - }, - "description": "The diagnostic settings." - }, - "LogSettings": { - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "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": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "a value indicating whether this log is enabled." - }, - "retentionPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/RetentionPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the retention policy for this log." - } - }, - "required": [ - "enabled" - ], - "description": "Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log." - }, - "MetricSettings": { - "type": "object", - "properties": { - "timeGrain": { - "type": "string", - "format": "duration", - "description": "the timegrain of the metric in ISO8601 format." - }, - "category": { - "type": "string", - "description": "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": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "a value indicating whether this category is enabled." - }, - "retentionPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/RetentionPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the retention policy for this category." - } - }, - "required": [ - "enabled" - ], - "description": "Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric." - }, - "RetentionPolicy": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "a value indicating whether the retention policy is enabled." - }, - "days": { - "oneOf": [ - { - "type": "integer", - "minimum": 0 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "the number of days for the retention in days. A value of 0 will retain the events indefinitely." - } - }, - "required": [ - "enabled", - "days" - ], - "description": "Specifies the retention policy for the log." - } - } -} diff --git a/test/Resource/Expected/Network/2016-03-30/Microsoft.Network.json b/test/Resource/Expected/Network/2016-03-30/Microsoft.Network.json deleted file mode 100644 index d17a804..0000000 --- a/test/Resource/Expected/Network/2016-03-30/Microsoft.Network.json +++ /dev/null @@ -1,5376 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-03-30/Microsoft.Network.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Network", - "description": "Microsoft Network Resource Types", - "resourceDefinitions": { - "applicationGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationGateways" - }, - "connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/connections" - }, - "expressRouteCircuits": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets sku" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/expressRouteCircuits_authorizations_childResource" - }, - { - "$ref": "#/definitions/expressRouteCircuits_peerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits" - }, - "expressRouteCircuits_authorizations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "loadBalancers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers" - }, - "localNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/localNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/localNetworkGateways" - }, - "networkInterfaces": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkInterfaces" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkInterfaces" - }, - "networkSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkSecurityGroups_securityRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups" - }, - "networkSecurityGroups_securityRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups/securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "publicIPAddresses": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/publicIPAddresses" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/publicIPAddresses" - }, - "routeTables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeTables_routes_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables" - }, - "routeTables_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "virtualNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworkGateways" - }, - "virtualNetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualNetworks_subnets_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks" - }, - "virtualNetworks_subnets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - } - }, - "definitions": { - "AddressSpace": { - "type": "object", - "properties": { - "addressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets List of address blocks reserved for this virtual network in CIDR notation" - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets" - }, - "ApplicationGatewayBackendAddress": { - "type": "object", - "properties": { - "fqdn": { - "type": "string", - "description": "Gets or sets the dns name" - }, - "ipAddress": { - "type": "string", - "description": "Gets or sets the ip address" - } - }, - "description": "Backend Address of application gateway" - }, - "ApplicationGatewayBackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Backend Address Pool of application gateway" - }, - "ApplicationGatewayBackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets collection of references to IPs defined in NICs" - }, - "backendAddresses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddress" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the backend addresses" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Backend Address Pool of application gateway" - }, - "ApplicationGatewayBackendHttpSettings": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Backend address pool settings of application gateway" - }, - "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the port" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the protocol." - }, - "cookieBasedAffinity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the cookie affinity." - }, - "requestTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets request timeout" - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets probe resource of application gateway " - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Backend address pool settings of application gateway" - }, - "ApplicationGatewayFrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Frontend IP configuration of application gateway" - }, - "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "Gets or sets the privateIPAddress of the Network Interface IP Configuration" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP allocation method (Static/Dynamic)." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the subnet resource" - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the PublicIP resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Frontend IP configuration of application gateway" - }, - "ApplicationGatewayFrontendPort": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Frontend Port of application gateway" - }, - "ApplicationGatewayFrontendPortPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the frontend port" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the frontend port resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Frontend Port of application gateway" - }, - "ApplicationGatewayHttpListener": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Http listener of application gateway" - }, - "ApplicationGatewayHttpListenerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets frontend IP configuration resource of application gateway " - }, - "frontendPort": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets frontend port resource of application gateway " - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the protocol." - }, - "hostName": { - "type": "string", - "description": "Gets or sets the host name of http listener " - }, - "sslCertificate": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets ssl certificate resource of application gateway " - }, - "requireServerNameIndication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the requireServerNameIndication of http listener " - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Http listener of application gateway" - }, - "ApplicationGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "IP configuration of application gateway" - }, - "ApplicationGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the subnet resource.A subnet from where appliation gateway gets its private address " - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed" - } - }, - "description": "Properties of IP configuration of application gateway" - }, - "ApplicationGatewayPathRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Path rule of URL path map of application gateway" - }, - "ApplicationGatewayPathRulePropertiesFormat": { - "type": "object", - "properties": { - "paths": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the path rules of URL path map" - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets backend address pool resource of URL path map " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets backend http settings resource of URL path map " - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets path rule of URL path map resource Updating/Deleting/Failed" - } - }, - "description": "Properties of probe of application gateway" - }, - "ApplicationGatewayProbe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Probe of application gateway" - }, - "ApplicationGatewayProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the protocol." - }, - "host": { - "type": "string", - "description": "Gets or sets the host to send probe to " - }, - "path": { - "type": "string", - "description": "Gets or sets the relative path of probe " - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets probing interval in seconds " - }, - "timeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets probing timeout in seconds " - }, - "unhealthyThreshold": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets probing unhealthy threshold " - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed" - } - }, - "description": "Properties of probe of application gateway" - }, - "ApplicationGatewayPropertiesFormat": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets sku of application gateway resource" - }, - "gatewayIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets subnets of application gateway resource" - }, - "sslCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewaySslCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets ssl certificates of application gateway resource" - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets frontend IP addresses of application gateway resource" - }, - "frontendPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendPort" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets frontend ports of application gateway resource" - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayProbe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets probes of application gateway resource" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets backend address pool of application gateway resource" - }, - "backendHttpSettingsCollection": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets backend http settings of application gateway resource" - }, - "httpListeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayHttpListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets HTTP listeners of application gateway resource" - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayUrlPathMap" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets URL path map of application gateway resource" - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets request routing rules of application gateway resource" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the ApplicationGateway resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Application Gateway" - }, - "ApplicationGatewayRequestRoutingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Request routing rule of application gateway" - }, - "ApplicationGatewayRequestRoutingRulePropertiesFormat": { - "type": "object", - "properties": { - "ruleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "PathBasedRouting" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the rule type." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets backend address pool resource of application gateway " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets frontend port resource of application gateway " - }, - "httpListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets http listener resource of application gateway " - }, - "urlPathMap": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets url path map resource of application gateway " - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the request routing rule resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Request routing rule of application gateway" - }, - "ApplicationGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_Small", - "Standard_Medium", - "Standard_Large" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets name of application gateway SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets tier of application gateway." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets capacity (instance count) of application gateway" - } - }, - "description": "SKU of application gateway" - }, - "ApplicationGatewaySslCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "SSL certificates of application gateway" - }, - "ApplicationGatewaySslCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Gets or sets the certificate data " - }, - "password": { - "type": "string", - "description": "Gets or sets the certificate password " - }, - "publicCertData": { - "type": "string", - "description": "Gets or sets the certificate public data " - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed" - } - }, - "description": "Properties of SSL certificates of application gateway" - }, - "ApplicationGatewayUrlPathMap": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "UrlPathMap of application gateway" - }, - "ApplicationGatewayUrlPathMapPropertiesFormat": { - "type": "object", - "properties": { - "defaultBackendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets default backend address pool resource of URL path map " - }, - "defaultBackendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets default backend http settings resource of URL path map " - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayPathRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets path rule of URL path map resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed" - } - }, - "description": "Properties of probe of application gateway" - }, - "AuthorizationPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "Gets or sets the authorization key" - }, - "authorizationUseStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Available", - "InUse" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets AuthorizationUseStatus." - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - } - }, - "BackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Pool of backend IP addresseses" - }, - "BackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets collection of references to IPs defined in NICs" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets Load Balancing rules that use this Backend Address Pool" - }, - "outboundNatRule": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets outbound rules that use this Backend Address Pool" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of BackendAddressPool" - }, - "BgpSettings": { - "type": "object", - "properties": { - "asn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets this BGP speaker's ASN" - }, - "bgpPeeringAddress": { - "type": "string", - "description": "Gets or sets the BGP peering address and BGP identifier of this BGP speaker" - }, - "peerWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the weight added to routes learned from this BGP speaker" - } - } - }, - "DhcpOptions": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of DNS servers IP addresses" - } - }, - "description": "DHCPOptions contains an array of DNS servers available to VMs deployed in the virtual networkStandard DHCP option for a subnet overrides VNET DHCP options." - }, - "ExpressRouteCircuitAuthorization": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Authorization in a ExpressRouteCircuit resource" - }, - "ExpressRouteCircuitPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Peering in a ExpressRouteCircuit resource" - }, - "ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "advertisedPublicPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of AdvertisedPublicPrefixes" - }, - "advertisedPublicPrefixesState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotConfigured", - "Configuring", - "Configured", - "ValidationNeeded" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets AdvertisedPublicPrefixState of the Peering resource." - }, - "customerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or Sets CustomerAsn of the peering." - }, - "routingRegistryName": { - "type": "string", - "description": "Gets or Sets RoutingRegistryName of the config." - } - }, - "description": "Specfies the peering config" - }, - "ExpressRouteCircuitPeeringPropertiesFormat": { - "type": "object", - "properties": { - "peeringType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzurePublicPeering", - "AzurePrivatePeering", - "MicrosoftPeering" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PeeringType." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets state of Peering." - }, - "azureASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the azure ASN" - }, - "peerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the peer ASN" - }, - "primaryPeerAddressPrefix": { - "type": "string", - "description": "Gets or sets the primary address prefix" - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "Gets or sets the secondary address prefix" - }, - "primaryAzurePort": { - "type": "string", - "description": "Gets or sets the primary port" - }, - "secondaryAzurePort": { - "type": "string", - "description": "Gets or sets the secondary port" - }, - "sharedKey": { - "type": "string", - "description": "Gets or sets the shared key" - }, - "vlanId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the vlan id" - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the mircosoft peering config" - }, - "stats": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitStats" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or peering stats" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - } - }, - "ExpressRouteCircuitPropertiesFormat": { - "type": "object", - "properties": { - "allowClassicOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "allow classic operations" - }, - "circuitProvisioningState": { - "type": "string", - "description": "Gets or sets CircuitProvisioningState state of the resource " - }, - "serviceProviderProvisioningState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotProvisioned", - "Provisioning", - "Provisioned", - "Deprovisioning" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets ServiceProviderProvisioningState state of the resource." - }, - "authorizations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitAuthorization" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of authorizations" - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of peerings" - }, - "serviceKey": { - "type": "string", - "description": "Gets or sets ServiceKey" - }, - "serviceProviderNotes": { - "type": "string", - "description": "Gets or sets ServiceProviderNotes" - }, - "serviceProviderProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets ServiceProviderProperties" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of ExpressRouteCircuit" - }, - "ExpressRouteCircuitServiceProviderProperties": { - "type": "object", - "properties": { - "serviceProviderName": { - "type": "string", - "description": "Gets or sets serviceProviderName." - }, - "peeringLocation": { - "type": "string", - "description": "Gets or sets peering location." - }, - "bandwidthInMbps": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets BandwidthInMbps." - } - }, - "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit" - }, - "ExpressRouteCircuitSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets name of the sku." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets tier of the sku." - }, - "family": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UnlimitedData", - "MeteredData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets family of the sku." - } - }, - "description": "Contains sku in an ExpressRouteCircuit" - }, - "ExpressRouteCircuitStats": { - "type": "object", - "properties": { - "primarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "primarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - }, - "secondarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "secondarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - } - }, - "description": "Contains Stats associated with the peering" - }, - "expressRouteCircuits_authorizations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "FrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Frontend IP address of the load balancer" - }, - "FrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Read only.Inbound rules URIs that use this frontend IP" - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Read only.Inbound pools URIs that use this frontend IP" - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Read only.Outbound rules URIs that use this frontend IP" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets Load Balancing rules URIs that use this frontend IP" - }, - "privateIPAddress": { - "type": "string", - "description": "Gets or sets the privateIPAddress of the IP Configuration" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP allocation method (Static/Dynamic)." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the subnet resource" - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the PublicIP resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Frontend IP Configuration of the load balancer" - }, - "InboundNatPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Inbound NAT pool of the loadbalancer" - }, - "InboundNatPoolPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to frontend IP Addresses" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp." - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the starting port range for the NAT pool. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the ending port range for the NAT pool. You can spcify 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" - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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 compotnent 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" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "protocol", - "frontendPortRangeStart", - "frontendPortRangeEnd", - "backendPort" - ], - "description": "Properties of Inbound NAT pool" - }, - "InboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Inbound NAT rule of the loadbalancer" - }, - "InboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to frontend IP Addresses" - }, - "backendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the port for the external endpoint. You can spcify 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" - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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 compotnent 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" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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 emlement is only used when the protocol is set to Tcp" - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual 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" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Inbound NAT rule" - }, - "IPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "IPConfiguration" - }, - "IPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "Gets or sets the privateIPAddress of the IP Configuration" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP allocation method (Static/Dynamic)." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the subnet resource" - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the PublicIP resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of IPConfiguration" - }, - "LoadBalancerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/FrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets frontend IP addresses of the load balancer" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Pools of backend IP addresseses" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets loadbalancing rules" - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Probe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of Load balancer probes" - }, - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of inbound rules" - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets inbound NAT pools" - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/OutboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets outbound NAT rules" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the Load balancer resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Load Balancer" - }, - "LoadBalancingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Rules of the load balancer" - }, - "LoadBalancingRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to frontend IP Addresses" - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs" - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the load balancer probe used by the Load Balancing rule." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp." - }, - "loadDistribution": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "SourceIP", - "SourceIPProtocol" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the load distribution policy for this rule." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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 compotnent 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" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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 emlement is only used when the protocol is set to Tcp" - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual 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" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "protocol", - "frontendPort" - ], - "description": "Properties of the load balancer" - }, - "LocalNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "A common class for general resource information" - }, - "LocalNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "localNetworkAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network site Address space" - }, - "gatewayIpAddress": { - "type": "string", - "description": "IP address of local network gateway." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network gateway's BGP speaker settings" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the LocalNetworkGateway resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed" - } - }, - "description": "LocalNetworkGateway properties" - }, - "NetworkInterface": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "A NetworkInterface in a resource group" - }, - "NetworkInterfaceDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of DNS servers IP addresses" - }, - "appliedDnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of Applied DNS servers IP addresses" - }, - "internalDnsNameLabel": { - "type": "string", - "description": "Gets or sets the Internal DNS name" - }, - "internalFqdn": { - "type": "string", - "description": "Gets or sets the internal fqdn." - }, - "internalDomainNameSuffix": { - "type": "string", - "description": "Gets or sets internal domain name suffix of the NIC." - } - }, - "description": "Dns Settings of a network interface" - }, - "NetworkInterfaceIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "IPConfiguration in a NetworkInterface" - }, - "NetworkInterfaceIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of ApplicationGatewayBackendAddressPool resource" - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of LoadBalancerBackendAddressPool resource" - }, - "loadBalancerInboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of references of LoadBalancerInboundNatRules" - }, - "privateIPAddress": { - "type": "string" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP allocation method (Static/Dynamic)." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP address version (IPv4/IPv6)." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary customer address on the NIC" - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "provisioningState": { - "type": "string" - } - }, - "description": "Properties of IPConfiguration" - }, - "NetworkInterfacePropertiesFormat": { - "type": "object", - "properties": { - "virtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of a VirtualMachine" - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the NetworkSecurityGroup resource" - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of IPConfigurations of the NetworkInterface" - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets DNS Settings in NetworkInterface" - }, - "macAddress": { - "type": "string", - "description": "Gets the MAC Address of the network interface" - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary NIC on a virtual machine" - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets whether IPForwarding is enabled on the NIC" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the network interface resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "NetworkInterface properties. " - }, - "NetworkSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "NetworkSecurityGroup resource" - }, - "NetworkSecurityGroupPropertiesFormat": { - "type": "object", - "properties": { - "securityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Security rules of network security group" - }, - "defaultSecurityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Default security rules of network security group" - }, - "networkInterfaces": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterface" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets collection of references to Network Interfaces" - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets collection of references to subnets" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the network security group resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Network Security Group resource" - }, - "networkSecurityGroups_securityRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "OutboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OutboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Outbound NAT pool of the loadbalancer" - }, - "OutboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "allocatedOutboundPorts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the number of outbound ports to be used for SNAT" - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Frontend IP addresses of the load balancer" - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "backendAddressPool" - ], - "description": "Outbound NAT pool of the loadbalancer" - }, - "Probe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Load balancer Probe" - }, - "ProbePropertiesFormat": { - "type": "object", - "properties": { - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets Load balancer rules that use this probe" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive." - }, - "intervalInSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "numberOfProbes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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 endponints to be taken out of rotation faster or slower than the typical times used in Azure. " - }, - "requestPath": { - "type": "string", - "description": "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" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "protocol", - "port" - ] - }, - "PublicIPAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "PublicIPAddress resource" - }, - "PublicIPAddressDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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": { - "type": "string", - "description": "Gets or Sests 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. " - } - }, - "description": "Contains FQDN of the DNS record associated with the public IP address" - }, - "PublicIPAddressPropertiesFormat": { - "type": "object", - "properties": { - "publicIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PublicIP allocation method (Static/Dynamic)." - }, - "publicIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PublicIP address version (IPv4/IPv6)." - }, - "ipConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/IPConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets FQDN of the DNS record associated with the public IP address" - }, - "ipAddress": { - "type": "string" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the Idletimeout of the public IP address" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the PublicIP resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "PublicIpAddress properties" - }, - "Route": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Route resource" - }, - "RoutePropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "Gets or sets the destination CIDR to which the route applies." - }, - "nextHopType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VirtualNetworkGateway", - "VnetLocal", - "Internet", - "VirtualAppliance", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the type of Azure hop the packet should be sent to." - }, - "nextHopIpAddress": { - "type": "string", - "description": "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." - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the resource Updating/Deleting/Failed" - } - }, - "required": [ - "nextHopType" - ], - "description": "Route resource" - }, - "RouteTable": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "RouteTable resource" - }, - "RouteTablePropertiesFormat": { - "type": "object", - "properties": { - "routes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Route" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Routes in a Route Table" - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets collection of references to subnets" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the resource Updating/Deleting/Failed" - } - }, - "description": "Route Table resource" - }, - "routeTables_routes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "SecurityRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Network security rule" - }, - "SecurityRulePropertiesFormat": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Gets or sets a description for this rule. Restricted to 140 chars." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp", - "*" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*)." - }, - "sourcePortRange": { - "type": "string", - "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "destinationPortRange": { - "type": "string", - "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "sourceAddressPrefix": { - "type": "string", - "description": "Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " - }, - "destinationAddressPrefix": { - "type": "string", - "description": "Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. " - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'." - }, - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic." - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "protocol", - "sourceAddressPrefix", - "destinationAddressPrefix", - "access", - "direction" - ] - }, - "Subnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Subnet in a VirtualNework resource" - }, - "SubnetPropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "Gets or sets Address prefix for the subnet." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the NetworkSecurityGroup resource" - }, - "routeTable": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTable" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the RouteTable resource" - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets array of references to the network interface IP configurations using subnet" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - } - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - } - }, - "VirtualNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "A common class for general resource information" - }, - "VirtualNetworkGatewayConnectionPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorizationKey." - }, - "virtualNetworkGateway1": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "virtualNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "localNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "connectionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPsec", - "Vnet2Vnet", - "ExpressRoute", - "VPNClient" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway connection type -Ipsec/Dedicated/VpnClient/Vnet2Vnet." - }, - "routingWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Routing weight." - }, - "sharedKey": { - "type": "string", - "description": "The Ipsec share key." - }, - "connectionStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Unknown", - "Connecting", - "Connected", - "NotConnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network Gateway connection status." - }, - "egressBytesTransferred": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Egress Bytes Transferred in this connection" - }, - "ingressBytesTransferred": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Ingress Bytes Transferred in this connection" - }, - "peer": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to peerings resource." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp Flag" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed" - } - }, - "description": "VirtualNeworkGatewayConnection properties" - }, - "VirtualNetworkGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "IpConfiguration for Virtual network gateway" - }, - "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "Gets or sets the privateIPAddress of the IP Configuration" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP allocation method (Static/Dynamic)." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the subnet resource" - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the PublicIP resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of VirtualNetworkGatewayIPConfiguration" - }, - "VirtualNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IpConfigurations for Virtual network gateway." - }, - "gatewayType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Vpn", - "ExpressRoute" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PolicyBased", - "RouteBased" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp Flag" - }, - "gatewayDefaultSite": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway." - }, - "vpnClientConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network gateway's BGP speaker settings" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the VirtualNetworkGateway resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed" - } - }, - "description": "VirtualNeworkGateay properties" - }, - "VirtualNetworkGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway sku name -Basic/HighPerformance/Standard." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway sku tier -Basic/HighPerformance/Standard." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity" - } - }, - "description": "VirtualNetworkGatewaySku details" - }, - "VirtualNetworkPropertiesFormat": { - "type": "object", - "properties": { - "addressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets AddressSpace that contains an array of IP address ranges that can be used by subnets" - }, - "dhcpOptions": { - "oneOf": [ - { - "$ref": "#/definitions/DhcpOptions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtual network" - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets List of subnets in a VirtualNetwork" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the VirtualNetwork resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - } - }, - "virtualNetworks_subnets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-30" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "VpnClientConfiguration": { - "type": "object", - "properties": { - "vpnClientAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient." - }, - "vpnClientRootCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRootCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRootCertificate for Virtual network gateway." - }, - "vpnClientRevokedCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRevokedCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRevokedCertificate for Virtual network gateway." - } - }, - "description": "VpnClientConfiguration for P2S client" - }, - "VpnClientRevokedCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "VPN client revoked certificate of virtual network gateway" - }, - "VpnClientRevokedCertificatePropertiesFormat": { - "type": "object", - "properties": { - "thumbprint": { - "type": "string", - "description": "Gets or sets the revoked Vpn client certificate thumbprint" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed" - } - }, - "description": "Properties of the revoked VPN client certificate of virtual network gateway" - }, - "VpnClientRootCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "VPN client root certificate of virtual network gateway" - }, - "VpnClientRootCertificatePropertiesFormat": { - "type": "object", - "properties": { - "publicCertData": { - "type": "string", - "description": "Gets or sets the certificate public data" - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets Provisioning state of the VPN client root certificate resource Updating/Deleting/Failed" - } - }, - "description": "Properties of SSL certificates of application gateway" - } - } -} diff --git a/test/Resource/Expected/Network/2016-03-30/applicationGateways.md b/test/Resource/Expected/Network/2016-03-30/applicationGateways.md deleted file mode 100644 index bf711cd..0000000 --- a/test/Resource/Expected/Network/2016-03-30/applicationGateways.md +++ /dev/null @@ -1,1127 +0,0 @@ -# Microsoft.Network/applicationGateways template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/applicationGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationGateways", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": { - "name": "string", - "tier": "Standard", - "capacity": "integer" - }, - "gatewayIPConfigurations": [ - { - "id": "string", - "properties": { - "subnet": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "sslCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "password": "string", - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendPorts": [ - { - "id": "string", - "properties": { - "port": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "host": "string", - "path": "string", - "interval": "integer", - "timeout": "integer", - "unhealthyThreshold": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - "ApplicationGatewayBackendAddressPool" - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - "IPConfiguration" - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendHttpSettingsCollection": [ - { - "id": "string", - "properties": { - "port": "integer", - "protocol": "string", - "cookieBasedAffinity": "string", - "requestTimeout": "integer", - "probe": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "httpListeners": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "frontendPort": { - "id": "string" - }, - "protocol": "string", - "hostName": "string", - "sslCertificate": { - "id": "string" - }, - "requireServerNameIndication": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "urlPathMaps": [ - { - "id": "string", - "properties": { - "defaultBackendAddressPool": { - "id": "string" - }, - "defaultBackendHttpSettings": { - "id": "string" - }, - "pathRules": [ - { - "id": "string", - "properties": { - "paths": [ - "string" - ], - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "requestRoutingRules": [ - { - "id": "string", - "properties": { - "ruleType": "string", - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "httpListener": { - "id": "string" - }, - "urlPathMap": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationGateways | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [ApplicationGatewayPropertiesFormat object](#ApplicationGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | Gets or sets sku of application gateway resource - [ApplicationGatewaySku object](#ApplicationGatewaySku) | -| gatewayIPConfigurations | array | No | Gets or sets subnets of application gateway resource - [ApplicationGatewayIPConfiguration object](#ApplicationGatewayIPConfiguration) | -| sslCertificates | array | No | Gets or sets ssl certificates of application gateway resource - [ApplicationGatewaySslCertificate object](#ApplicationGatewaySslCertificate) | -| frontendIPConfigurations | array | No | Gets or sets frontend IP addresses of application gateway resource - [ApplicationGatewayFrontendIPConfiguration object](#ApplicationGatewayFrontendIPConfiguration) | -| frontendPorts | array | No | Gets or sets frontend ports of application gateway resource - [ApplicationGatewayFrontendPort object](#ApplicationGatewayFrontendPort) | -| probes | array | No | Gets or sets probes of application gateway resource - [ApplicationGatewayProbe object](#ApplicationGatewayProbe) | -| backendAddressPools | array | No | Gets or sets backend address pool of application gateway resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| backendHttpSettingsCollection | array | No | Gets or sets backend http settings of application gateway resource - [ApplicationGatewayBackendHttpSettings object](#ApplicationGatewayBackendHttpSettings) | -| httpListeners | array | No | Gets or sets HTTP listeners of application gateway resource - [ApplicationGatewayHttpListener object](#ApplicationGatewayHttpListener) | -| urlPathMaps | array | No | Gets or sets URL path map of application gateway resource - [ApplicationGatewayUrlPathMap object](#ApplicationGatewayUrlPathMap) | -| requestRoutingRules | array | No | Gets or sets request routing rules of application gateway resource - [ApplicationGatewayRequestRoutingRule object](#ApplicationGatewayRequestRoutingRule) | -| resourceGuid | string | No | Gets or sets resource guid property of the ApplicationGateway resource | -| provisioningState | string | No | Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed | - - - -### ApplicationGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gets or sets name of application gateway SKU. - Standard_Small, Standard_Medium, Standard_Large | -| tier | enum | No | Gets or sets tier of application gateway. - Standard | -| capacity | integer | No | Gets or sets capacity (instance count) of application gateway | - - - -### ApplicationGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayIPConfigurationPropertiesFormat object](#ApplicationGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewaySslCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewaySslCertificatePropertiesFormat object](#ApplicationGatewaySslCertificatePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayFrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayFrontendIPConfigurationPropertiesFormat object](#ApplicationGatewayFrontendIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayFrontendPort object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayFrontendPortPropertiesFormat object](#ApplicationGatewayFrontendPortPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayProbe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayProbePropertiesFormat object](#ApplicationGatewayProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendHttpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendHttpSettingsPropertiesFormat object](#ApplicationGatewayBackendHttpSettingsPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayHttpListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayHttpListenerPropertiesFormat object](#ApplicationGatewayHttpListenerPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayUrlPathMap object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayUrlPathMapPropertiesFormat object](#ApplicationGatewayUrlPathMapPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayRequestRoutingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayRequestRoutingRulePropertiesFormat object](#ApplicationGatewayRequestRoutingRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Gets or sets the reference of the subnet resource.A subnet from where appliation gateway gets its private address - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed | - - - -### ApplicationGatewaySslCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Gets or sets the certificate data | -| password | string | No | Gets or sets the certificate password | -| publicCertData | string | No | Gets or sets the certificate public data | -| provisioningState | string | No | Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed | - - - -### ApplicationGatewayFrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the Network Interface IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayFrontendPortPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Gets or sets the frontend port | -| provisioningState | string | No | Gets or sets Provisioning state of the frontend port resource Updating/Deleting/Failed | - - - -### ApplicationGatewayProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Gets or sets the protocol. - Http or Https | -| host | string | No | Gets or sets the host to send probe to | -| path | string | No | Gets or sets the relative path of probe | -| interval | integer | No | Gets or sets probing interval in seconds | -| timeout | integer | No | Gets or sets probing timeout in seconds | -| unhealthyThreshold | integer | No | Gets or sets probing unhealthy threshold | -| provisioningState | string | No | Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Gets or sets the backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendHttpSettingsPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Gets or sets the port | -| protocol | enum | No | Gets or sets the protocol. - Http or Https | -| cookieBasedAffinity | enum | No | Gets or sets the cookie affinity. - Enabled or Disabled | -| requestTimeout | integer | No | Gets or sets request timeout | -| probe | object | No | Gets or sets probe resource of application gateway - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed | - - - -### ApplicationGatewayHttpListenerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets frontend IP configuration resource of application gateway - [SubResource object](#SubResource) | -| frontendPort | object | No | Gets or sets frontend port resource of application gateway - [SubResource object](#SubResource) | -| protocol | enum | No | Gets or sets the protocol. - Http or Https | -| hostName | string | No | Gets or sets the host name of http listener | -| sslCertificate | object | No | Gets or sets ssl certificate resource of application gateway - [SubResource object](#SubResource) | -| requireServerNameIndication | boolean | No | Gets or sets the requireServerNameIndication of http listener | -| provisioningState | string | No | Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed | - - - -### ApplicationGatewayUrlPathMapPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultBackendAddressPool | object | No | Gets or sets default backend address pool resource of URL path map - [SubResource object](#SubResource) | -| defaultBackendHttpSettings | object | No | Gets or sets default backend http settings resource of URL path map - [SubResource object](#SubResource) | -| pathRules | array | No | Gets or sets path rule of URL path map resource - [ApplicationGatewayPathRule object](#ApplicationGatewayPathRule) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed | - - - -### ApplicationGatewayRequestRoutingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleType | enum | No | Gets or sets the rule type. - Basic or PathBasedRouting | -| backendAddressPool | object | No | Gets or sets backend address pool resource of application gateway - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Gets or sets frontend port resource of application gateway - [SubResource object](#SubResource) | -| httpListener | object | No | Gets or sets http listener resource of application gateway - [SubResource object](#SubResource) | -| urlPathMap | object | No | Gets or sets url path map resource of application gateway - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets or sets Provisioning state of the request routing rule resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Gets or sets the dns name | -| ipAddress | string | No | Gets or sets the ip address | - - - -### ApplicationGatewayPathRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayPathRulePropertiesFormat object](#ApplicationGatewayPathRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### ApplicationGatewayPathRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| paths | array | No | Gets or sets the path rules of URL path map - string | -| backendAddressPool | object | No | Gets or sets backend address pool resource of URL path map - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Gets or sets backend http settings resource of URL path map - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets or sets path rule of URL path map resource Updating/Deleting/Failed | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| loadBalancingRules | array | No | Gets Load Balancing rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| outboundNatRule | object | No | Gets outbound rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendIPConfiguration | object | No | Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| protocol | enum | No | Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | Gets or sets the port for the external endpoint. You can spcify 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 | -| backendPort | integer | No | 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 compotnent 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 | -| idleTimeoutInMinutes | integer | No | 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 emlement is only used when the protocol is set to Tcp | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| ipConfigurations | array | No | Gets array of references to the network interface IP configurations using subnet - [IPConfiguration object](#IPConfiguration) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| ipConfiguration | object | No | [IPConfiguration object](#IPConfiguration) | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### IPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [IPConfigurationPropertiesFormat object](#IPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | Gets or Sests 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets Security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or sets Default security rules of network security group - [SecurityRule object](#SecurityRule) | -| networkInterfaces | array | No | Gets collection of references to Network Interfaces - [NetworkInterface object](#NetworkInterface) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### IPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterface object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | Gets or sets the reference of a VirtualMachine - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | Gets or sets list of IPConfigurations of the NetworkInterface - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | Gets or sets DNS Settings in NetworkInterface - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | Gets the MAC Address of the network interface | -| primary | boolean | No | Gets whether this is a primary NIC on a virtual machine | -| enableIPForwarding | boolean | No | Gets or sets whether IPForwarding is enabled on the NIC | -| resourceGuid | string | No | Gets or sets resource guid property of the network interface resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | -| appliedDnsServers | array | No | Gets or sets list of Applied DNS servers IP addresses - string | -| internalDnsNameLabel | string | No | Gets or sets the Internal DNS name | -| internalFqdn | string | No | Gets or sets the internal fqdn. | -| internalDomainNameSuffix | string | No | Gets or sets internal domain name suffix of the NIC. | - diff --git a/test/Resource/Expected/Network/2016-03-30/connections.md b/test/Resource/Expected/Network/2016-03-30/connections.md deleted file mode 100644 index d2d5dab..0000000 --- a/test/Resource/Expected/Network/2016-03-30/connections.md +++ /dev/null @@ -1,383 +0,0 @@ -# Microsoft.Network/connections template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/connections", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "authorizationKey": "string", - "virtualNetworkGateway1": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "virtualNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "localNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "connectionType": "string", - "routingWeight": "integer", - "sharedKey": "string", - "connectionStatus": "string", - "egressBytesTransferred": "integer", - "ingressBytesTransferred": "integer", - "peer": { - "id": "string" - }, - "enableBgp": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/connections | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualNetworkGatewayConnectionPropertiesFormat object](#VirtualNetworkGatewayConnectionPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### VirtualNetworkGatewayConnectionPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorizationKey. | -| virtualNetworkGateway1 | object | No | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| virtualNetworkGateway2 | object | No | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| localNetworkGateway2 | object | No | [LocalNetworkGateway object](#LocalNetworkGateway) | -| connectionType | enum | No | Gateway connection type -Ipsec/Dedicated/VpnClient/Vnet2Vnet. - IPsec, Vnet2Vnet, ExpressRoute, VPNClient | -| routingWeight | integer | No | The Routing weight. | -| sharedKey | string | No | The Ipsec share key. | -| connectionStatus | enum | No | Virtual network Gateway connection status. - Unknown, Connecting, Connected, NotConnected | -| egressBytesTransferred | integer | No | The Egress Bytes Transferred in this connection | -| ingressBytesTransferred | integer | No | The Ingress Bytes Transferred in this connection | -| peer | object | No | The reference to peerings resource. - [SubResource object](#SubResource) | -| enableBgp | boolean | No | EnableBgp Flag | -| resourceGuid | string | No | Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource | -| provisioningState | string | No | Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed | - - - -### VirtualNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### LocalNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IpConfigurations for Virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. - PolicyBased or RouteBased | -| enableBgp | boolean | No | EnableBgp Flag | -| gatewayDefaultSite | object | No | Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | Gets or sets resource guid property of the VirtualNetworkGateway resource | -| provisioningState | string | No | Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site Address space - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | Gets or sets resource guid property of the LocalNetworkGateway resource | -| provisioningState | string | No | Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway sku name -Basic/HighPerformance/Standard. - Basic, HighPerformance, Standard | -| tier | enum | No | Gateway sku tier -Basic/HighPerformance/Standard. - Basic, HighPerformance, Standard | -| capacity | integer | No | The capacity | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for Virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | Gets or sets this BGP speaker's ASN | -| bgpPeeringAddress | string | No | Gets or sets the BGP peering address and BGP identifier of this BGP speaker | -| peerWeight | integer | No | Gets or sets the weight added to routes learned from this BGP speaker | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | Gets or sets List of address blocks reserved for this virtual network in CIDR notation - string | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | No | Gets or sets the certificate public data | -| provisioningState | string | No | Gets or sets Provisioning state of the VPN client root certificate resource Updating/Deleting/Failed | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | Gets or sets the revoked Vpn client certificate thumbprint | -| provisioningState | string | No | Gets or sets Provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-03-30/expressRouteCircuits.md b/test/Resource/Expected/Network/2016-03-30/expressRouteCircuits.md deleted file mode 100644 index d2e9e43..0000000 --- a/test/Resource/Expected/Network/2016-03-30/expressRouteCircuits.md +++ /dev/null @@ -1,202 +0,0 @@ -# Microsoft.Network/expressRouteCircuits template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/expressRouteCircuits resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "family": "string" - }, - "properties": { - "allowClassicOperations": "boolean", - "circuitProvisioningState": "string", - "serviceProviderProvisioningState": "string", - "authorizations": [ - { - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "serviceKey": "string", - "serviceProviderNotes": "string", - "serviceProviderProperties": { - "serviceProviderName": "string", - "peeringLocation": "string", - "bandwidthInMbps": "integer" - }, - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | Gets or sets sku - [ExpressRouteCircuitSku object](#ExpressRouteCircuitSku) | -| properties | object | Yes | [ExpressRouteCircuitPropertiesFormat object](#ExpressRouteCircuitPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | -| resources | array | No | [peerings](./expressRouteCircuits/peerings.md) [authorizations](./expressRouteCircuits/authorizations.md) | - - - -### ExpressRouteCircuitSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets or sets name of the sku. | -| tier | enum | No | Gets or sets tier of the sku. - Standard or Premium | -| family | enum | No | Gets or sets family of the sku. - UnlimitedData or MeteredData | - - - -### ExpressRouteCircuitPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowClassicOperations | boolean | No | allow classic operations | -| circuitProvisioningState | string | No | Gets or sets CircuitProvisioningState state of the resource | -| serviceProviderProvisioningState | enum | No | Gets or sets ServiceProviderProvisioningState state of the resource. - NotProvisioned, Provisioning, Provisioned, Deprovisioning | -| authorizations | array | No | Gets or sets list of authorizations - [ExpressRouteCircuitAuthorization object](#ExpressRouteCircuitAuthorization) | -| peerings | array | No | Gets or sets list of peerings - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | -| serviceKey | string | No | Gets or sets ServiceKey | -| serviceProviderNotes | string | No | Gets or sets ServiceProviderNotes | -| serviceProviderProperties | object | No | Gets or sets ServiceProviderProperties - [ExpressRouteCircuitServiceProviderProperties object](#ExpressRouteCircuitServiceProviderProperties) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ExpressRouteCircuitAuthorization object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ExpressRouteCircuitServiceProviderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceProviderName | string | No | Gets or sets serviceProviderName. | -| peeringLocation | string | No | Gets or sets peering location. | -| bandwidthInMbps | integer | No | Gets or sets BandwidthInMbps. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | Gets or sets the authorization key | -| authorizationUseStatus | enum | No | Gets or sets AuthorizationUseStatus. - Available or InUse | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | Gets or sets PeeringType. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | Gets or sets state of Peering. - Disabled or Enabled | -| azureASN | integer | No | Gets or sets the azure ASN | -| peerASN | integer | No | Gets or sets the peer ASN | -| primaryPeerAddressPrefix | string | No | Gets or sets the primary address prefix | -| secondaryPeerAddressPrefix | string | No | Gets or sets the secondary address prefix | -| primaryAzurePort | string | No | Gets or sets the primary port | -| secondaryAzurePort | string | No | Gets or sets the secondary port | -| sharedKey | string | No | Gets or sets the shared key | -| vlanId | integer | No | Gets or sets the vlan id | -| microsoftPeeringConfig | object | No | Gets or sets the mircosoft peering config - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets or peering stats - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | Gets or sets the reference of AdvertisedPublicPrefixes - string | -| advertisedPublicPrefixesState | enum | No | Gets or sets AdvertisedPublicPrefixState of the Peering resource. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | Gets or Sets CustomerAsn of the peering. | -| routingRegistryName | string | No | Gets or Sets RoutingRegistryName of the config. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - diff --git a/test/Resource/Expected/Network/2016-03-30/expressRouteCircuits/authorizations.md b/test/Resource/Expected/Network/2016-03-30/expressRouteCircuits/authorizations.md deleted file mode 100644 index b8d76ad..0000000 --- a/test/Resource/Expected/Network/2016-03-30/expressRouteCircuits/authorizations.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/authorizations template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/authorizations", - "apiVersion": "2016-03-30", - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/authorizations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/authorizations | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| properties | object | Yes | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | Gets or sets the authorization key | -| authorizationUseStatus | enum | No | Gets or sets AuthorizationUseStatus. - Available or InUse | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-03-30/expressRouteCircuits/peerings.md b/test/Resource/Expected/Network/2016-03-30/expressRouteCircuits/peerings.md deleted file mode 100644 index 58426b3..0000000 --- a/test/Resource/Expected/Network/2016-03-30/expressRouteCircuits/peerings.md +++ /dev/null @@ -1,96 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/peerings template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/peerings", - "apiVersion": "2016-03-30", - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/peerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/peerings | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| properties | object | Yes | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | Gets or sets PeeringType. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | Gets or sets state of Peering. - Disabled or Enabled | -| azureASN | integer | No | Gets or sets the azure ASN | -| peerASN | integer | No | Gets or sets the peer ASN | -| primaryPeerAddressPrefix | string | No | Gets or sets the primary address prefix | -| secondaryPeerAddressPrefix | string | No | Gets or sets the secondary address prefix | -| primaryAzurePort | string | No | Gets or sets the primary port | -| secondaryAzurePort | string | No | Gets or sets the secondary port | -| sharedKey | string | No | Gets or sets the shared key | -| vlanId | integer | No | Gets or sets the vlan id | -| microsoftPeeringConfig | object | No | Gets or sets the mircosoft peering config - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets or peering stats - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | Gets or sets the reference of AdvertisedPublicPrefixes - string | -| advertisedPublicPrefixesState | enum | No | Gets or sets AdvertisedPublicPrefixState of the Peering resource. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | Gets or Sets CustomerAsn of the peering. | -| routingRegistryName | string | No | Gets or Sets RoutingRegistryName of the config. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - diff --git a/test/Resource/Expected/Network/2016-03-30/loadBalancers.md b/test/Resource/Expected/Network/2016-03-30/loadBalancers.md deleted file mode 100644 index 7141ced..0000000 --- a/test/Resource/Expected/Network/2016-03-30/loadBalancers.md +++ /dev/null @@ -1,1814 +0,0 @@ -# Microsoft.Network/loadBalancers template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/loadBalancers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "inboundNatRules": [ - { - "id": "string" - } - ], - "inboundNatPools": [ - { - "id": "string" - } - ], - "outboundNatRules": [ - { - "id": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": "Subnet", - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": "Subnet", - "primary": "boolean", - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - "IPConfiguration" - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - "BackendAddressPool" - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - "IPConfiguration" - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendAddressPool": { - "id": "string" - }, - "probe": { - "id": "string" - }, - "protocol": "string", - "loadDistribution": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "loadBalancingRules": [ - { - "id": "string" - } - ], - "protocol": "string", - "port": "integer", - "intervalInSeconds": "integer", - "numberOfProbes": "integer", - "requestPath": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - "InboundNatRule" - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - "IPConfiguration" - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatPools": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "backendPort": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "outboundNatRules": [ - { - "id": "string", - "properties": { - "allocatedOutboundPorts": "integer", - "frontendIPConfigurations": [ - { - "id": "string" - } - ], - "backendAddressPool": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [LoadBalancerPropertiesFormat object](#LoadBalancerPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### LoadBalancerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfigurations | array | No | Gets or sets frontend IP addresses of the load balancer - [FrontendIPConfiguration object](#FrontendIPConfiguration) | -| backendAddressPools | array | No | Gets or sets Pools of backend IP addresseses - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancingRules | array | No | Gets or sets loadbalancing rules - [LoadBalancingRule object](#LoadBalancingRule) | -| probes | array | No | Gets or sets list of Load balancer probes - [Probe object](#Probe) | -| inboundNatRules | array | No | Gets or sets list of inbound rules - [InboundNatRule object](#InboundNatRule) | -| inboundNatPools | array | No | Gets or sets inbound NAT pools - [InboundNatPool object](#InboundNatPool) | -| outboundNatRules | array | No | Gets or sets outbound NAT rules - [OutboundNatRule object](#OutboundNatRule) | -| resourceGuid | string | No | Gets or sets resource guid property of the Load balancer resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### FrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [FrontendIPConfigurationPropertiesFormat object](#FrontendIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### LoadBalancingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [LoadBalancingRulePropertiesFormat object](#LoadBalancingRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Probe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ProbePropertiesFormat object](#ProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatPoolPropertiesFormat object](#InboundNatPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### OutboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [OutboundNatRulePropertiesFormat object](#OutboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### FrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| inboundNatRules | array | No | Read only.Inbound rules URIs that use this frontend IP - [SubResource object](#SubResource) | -| inboundNatPools | array | No | Read only.Inbound pools URIs that use this frontend IP - [SubResource object](#SubResource) | -| outboundNatRules | array | No | Read only.Outbound rules URIs that use this frontend IP - [SubResource object](#SubResource) | -| loadBalancingRules | array | No | Gets Load Balancing rules URIs that use this frontend IP - [SubResource object](#SubResource) | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| loadBalancingRules | array | No | Gets Load Balancing rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| outboundNatRule | object | No | Gets outbound rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### LoadBalancingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendAddressPool | object | No | Gets or sets a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs - [SubResource object](#SubResource) | -| probe | object | No | Gets or sets the reference of the load balancer probe used by the Load Balancing rule. - [SubResource object](#SubResource) | -| protocol | enum | Yes | Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| loadDistribution | enum | No | Gets or sets the load distribution policy for this rule. - Default, SourceIP, SourceIPProtocol | -| frontendPort | integer | Yes | 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 | -| backendPort | integer | No | 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 compotnent 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 | -| idleTimeoutInMinutes | integer | No | 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 emlement is only used when the protocol is set to Tcp | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| loadBalancingRules | array | No | Gets Load balancer rules that use this probe - [SubResource object](#SubResource) | -| protocol | enum | Yes | 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. - Http or Tcp | -| port | integer | Yes | Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive. | -| intervalInSeconds | integer | No | 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 | -| numberOfProbes | integer | No | 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 endponints to be taken out of rotation faster or slower than the typical times used in Azure. | -| requestPath | string | No | 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendIPConfiguration | object | No | Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| protocol | enum | No | Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | Gets or sets the port for the external endpoint. You can spcify 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 | -| backendPort | integer | No | 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 compotnent 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 | -| idleTimeoutInMinutes | integer | No | 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 emlement is only used when the protocol is set to Tcp | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| protocol | enum | Yes | Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPortRangeStart | integer | Yes | Gets or sets the starting port range for the NAT pool. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive | -| frontendPortRangeEnd | integer | Yes | Gets or sets the ending port range for the NAT pool. You can spcify 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 | -| backendPort | integer | Yes | 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 compotnent 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### OutboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allocatedOutboundPorts | integer | No | Gets or sets the number of outbound ports to be used for SNAT | -| frontendIPConfigurations | array | No | Gets or sets Frontend IP addresses of the load balancer - [SubResource object](#SubResource) | -| backendAddressPool | object | Yes | Gets or sets a reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| ipConfigurations | array | No | Gets array of references to the network interface IP configurations using subnet - [IPConfiguration object](#IPConfiguration) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| ipConfiguration | object | No | [IPConfiguration object](#IPConfiguration) | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### IPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [IPConfigurationPropertiesFormat object](#IPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | Gets or Sests 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. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets Security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or sets Default security rules of network security group - [SecurityRule object](#SecurityRule) | -| networkInterfaces | array | No | Gets collection of references to Network Interfaces - [NetworkInterface object](#NetworkInterface) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### IPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Gets or sets the backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterface object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Gets or sets the dns name | -| ipAddress | string | No | Gets or sets the ip address | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | Gets or sets the reference of a VirtualMachine - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | Gets or sets list of IPConfigurations of the NetworkInterface - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | Gets or sets DNS Settings in NetworkInterface - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | Gets the MAC Address of the network interface | -| primary | boolean | No | Gets whether this is a primary NIC on a virtual machine | -| enableIPForwarding | boolean | No | Gets or sets whether IPForwarding is enabled on the NIC | -| resourceGuid | string | No | Gets or sets resource guid property of the network interface resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | -| appliedDnsServers | array | No | Gets or sets list of Applied DNS servers IP addresses - string | -| internalDnsNameLabel | string | No | Gets or sets the Internal DNS name | -| internalFqdn | string | No | Gets or sets the internal fqdn. | -| internalDomainNameSuffix | string | No | Gets or sets internal domain name suffix of the NIC. | - diff --git a/test/Resource/Expected/Network/2016-03-30/localNetworkGateways.md b/test/Resource/Expected/Network/2016-03-30/localNetworkGateways.md deleted file mode 100644 index c084b69..0000000 --- a/test/Resource/Expected/Network/2016-03-30/localNetworkGateways.md +++ /dev/null @@ -1,76 +0,0 @@ -# Microsoft.Network/localNetworkGateways template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/localNetworkGateways", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/localNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/localNetworkGateways | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site Address space - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | Gets or sets resource guid property of the LocalNetworkGateway resource | -| provisioningState | string | No | Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | Gets or sets List of address blocks reserved for this virtual network in CIDR notation - string | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | Gets or sets this BGP speaker's ASN | -| bgpPeeringAddress | string | No | Gets or sets the BGP peering address and BGP identifier of this BGP speaker | -| peerWeight | integer | No | Gets or sets the weight added to routes learned from this BGP speaker | - diff --git a/test/Resource/Expected/Network/2016-03-30/networkInterfaces.md b/test/Resource/Expected/Network/2016-03-30/networkInterfaces.md deleted file mode 100644 index 78d841f..0000000 --- a/test/Resource/Expected/Network/2016-03-30/networkInterfaces.md +++ /dev/null @@ -1,815 +0,0 @@ -# Microsoft.Network/networkInterfaces template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/networkInterfaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkInterfaces", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": "NetworkInterfacePropertiesFormat", - "etag": "string" - } - ], - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": "NetworkSecurityGroup", - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": "NetworkInterfacePropertiesFormat", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": "NetworkInterfacePropertiesFormat", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - "IPConfiguration" - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkInterfaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkInterfaces | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | Gets or sets the reference of a VirtualMachine - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | Gets or sets list of IPConfigurations of the NetworkInterface - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | Gets or sets DNS Settings in NetworkInterface - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | Gets the MAC Address of the network interface | -| primary | boolean | No | Gets whether this is a primary NIC on a virtual machine | -| enableIPForwarding | boolean | No | Gets or sets whether IPForwarding is enabled on the NIC | -| resourceGuid | string | No | Gets or sets resource guid property of the network interface resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | -| appliedDnsServers | array | No | Gets or sets list of Applied DNS servers IP addresses - string | -| internalDnsNameLabel | string | No | Gets or sets the Internal DNS name | -| internalFqdn | string | No | Gets or sets the internal fqdn. | -| internalDomainNameSuffix | string | No | Gets or sets internal domain name suffix of the NIC. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets Security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or sets Default security rules of network security group - [SecurityRule object](#SecurityRule) | -| networkInterfaces | array | No | Gets collection of references to Network Interfaces - [NetworkInterface object](#NetworkInterface) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterface object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| ipConfigurations | array | No | Gets array of references to the network interface IP configurations using subnet - [IPConfiguration object](#IPConfiguration) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Gets or sets the backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| loadBalancingRules | array | No | Gets Load Balancing rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| outboundNatRule | object | No | Gets outbound rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendIPConfiguration | object | No | Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| protocol | enum | No | Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | Gets or sets the port for the external endpoint. You can spcify 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 | -| backendPort | integer | No | 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 compotnent 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 | -| idleTimeoutInMinutes | integer | No | 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 emlement is only used when the protocol is set to Tcp | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| ipConfiguration | object | No | [IPConfiguration object](#IPConfiguration) | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### IPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [IPConfigurationPropertiesFormat object](#IPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Gets or sets the dns name | -| ipAddress | string | No | Gets or sets the ip address | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | Gets or Sests 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. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### IPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-03-30/networkSecurityGroups.md b/test/Resource/Expected/Network/2016-03-30/networkSecurityGroups.md deleted file mode 100644 index 1da2cd3..0000000 --- a/test/Resource/Expected/Network/2016-03-30/networkSecurityGroups.md +++ /dev/null @@ -1,717 +0,0 @@ -# Microsoft.Network/networkSecurityGroups template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/networkSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "NetworkSecurityGroupPropertiesFormat", - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "NetworkSecurityGroupPropertiesFormat", - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "NetworkSecurityGroupPropertiesFormat", - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - "IPConfiguration" - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "NetworkSecurityGroupPropertiesFormat", - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | -| resources | array | No | [securityRules](./networkSecurityGroups/securityRules.md) | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets Security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or sets Default security rules of network security group - [SecurityRule object](#SecurityRule) | -| networkInterfaces | array | No | Gets collection of references to Network Interfaces - [NetworkInterface object](#NetworkInterface) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterface object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | Gets or sets the reference of a VirtualMachine - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | Gets or sets list of IPConfigurations of the NetworkInterface - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | Gets or sets DNS Settings in NetworkInterface - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | Gets the MAC Address of the network interface | -| primary | boolean | No | Gets whether this is a primary NIC on a virtual machine | -| enableIPForwarding | boolean | No | Gets or sets whether IPForwarding is enabled on the NIC | -| resourceGuid | string | No | Gets or sets resource guid property of the network interface resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| ipConfigurations | array | No | Gets array of references to the network interface IP configurations using subnet - [IPConfiguration object](#IPConfiguration) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | -| appliedDnsServers | array | No | Gets or sets list of Applied DNS servers IP addresses - string | -| internalDnsNameLabel | string | No | Gets or sets the Internal DNS name | -| internalFqdn | string | No | Gets or sets the internal fqdn. | -| internalDomainNameSuffix | string | No | Gets or sets internal domain name suffix of the NIC. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### IPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [IPConfigurationPropertiesFormat object](#IPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### IPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Gets or sets the backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| loadBalancingRules | array | No | Gets Load Balancing rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| outboundNatRule | object | No | Gets outbound rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendIPConfiguration | object | No | Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| protocol | enum | No | Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | Gets or sets the port for the external endpoint. You can spcify 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 | -| backendPort | integer | No | 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 compotnent 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 | -| idleTimeoutInMinutes | integer | No | 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 emlement is only used when the protocol is set to Tcp | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| ipConfiguration | object | No | [IPConfiguration object](#IPConfiguration) | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Gets or sets the dns name | -| ipAddress | string | No | Gets or sets the ip address | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | Gets or Sests 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. | - diff --git a/test/Resource/Expected/Network/2016-03-30/networkSecurityGroups/securityRules.md b/test/Resource/Expected/Network/2016-03-30/networkSecurityGroups/securityRules.md deleted file mode 100644 index 7181034..0000000 --- a/test/Resource/Expected/Network/2016-03-30/networkSecurityGroups/securityRules.md +++ /dev/null @@ -1,58 +0,0 @@ -# Microsoft.Network/networkSecurityGroups/securityRules template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/networkSecurityGroups/securityRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups/securityRules", - "apiVersion": "2016-03-30", - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups/securityRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups/securityRules | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| properties | object | Yes | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-03-30/publicIPAddresses.md b/test/Resource/Expected/Network/2016-03-30/publicIPAddresses.md deleted file mode 100644 index fa5f56d..0000000 --- a/test/Resource/Expected/Network/2016-03-30/publicIPAddresses.md +++ /dev/null @@ -1,569 +0,0 @@ -# Microsoft.Network/publicIPAddresses template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/publicIPAddresses", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": "Subnet", - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "PublicIPAddressPropertiesFormat", - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - "IPConfiguration" - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "PublicIPAddressPropertiesFormat", - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/publicIPAddresses object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/publicIPAddresses | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| ipConfiguration | object | No | [IPConfiguration object](#IPConfiguration) | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### IPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [IPConfigurationPropertiesFormat object](#IPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | Gets or Sests 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. | - - - -### IPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| ipConfigurations | array | No | Gets array of references to the network interface IP configurations using subnet - [IPConfiguration object](#IPConfiguration) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets Security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or sets Default security rules of network security group - [SecurityRule object](#SecurityRule) | -| networkInterfaces | array | No | Gets collection of references to Network Interfaces - [NetworkInterface object](#NetworkInterface) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterface object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | Gets or sets the reference of a VirtualMachine - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | Gets or sets list of IPConfigurations of the NetworkInterface - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | Gets or sets DNS Settings in NetworkInterface - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | Gets the MAC Address of the network interface | -| primary | boolean | No | Gets whether this is a primary NIC on a virtual machine | -| enableIPForwarding | boolean | No | Gets or sets whether IPForwarding is enabled on the NIC | -| resourceGuid | string | No | Gets or sets resource guid property of the network interface resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | -| appliedDnsServers | array | No | Gets or sets list of Applied DNS servers IP addresses - string | -| internalDnsNameLabel | string | No | Gets or sets the Internal DNS name | -| internalFqdn | string | No | Gets or sets the internal fqdn. | -| internalDomainNameSuffix | string | No | Gets or sets internal domain name suffix of the NIC. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Gets or sets the backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| loadBalancingRules | array | No | Gets Load Balancing rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| outboundNatRule | object | No | Gets outbound rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendIPConfiguration | object | No | Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| protocol | enum | No | Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | Gets or sets the port for the external endpoint. You can spcify 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 | -| backendPort | integer | No | 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 compotnent 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 | -| idleTimeoutInMinutes | integer | No | 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 emlement is only used when the protocol is set to Tcp | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Gets or sets the dns name | -| ipAddress | string | No | Gets or sets the ip address | - diff --git a/test/Resource/Expected/Network/2016-03-30/routeTables.md b/test/Resource/Expected/Network/2016-03-30/routeTables.md deleted file mode 100644 index 529ecb2..0000000 --- a/test/Resource/Expected/Network/2016-03-30/routeTables.md +++ /dev/null @@ -1,595 +0,0 @@ -# Microsoft.Network/routeTables template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/routeTables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": "Subnet", - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "RouteTablePropertiesFormat", - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | -| resources | array | No | [routes](./routeTables/routes.md) | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| ipConfigurations | array | No | Gets array of references to the network interface IP configurations using subnet - [IPConfiguration object](#IPConfiguration) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### IPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [IPConfigurationPropertiesFormat object](#IPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets Security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or sets Default security rules of network security group - [SecurityRule object](#SecurityRule) | -| networkInterfaces | array | No | Gets collection of references to Network Interfaces - [NetworkInterface object](#NetworkInterface) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### IPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterface object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | Gets or sets the reference of a VirtualMachine - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | Gets or sets list of IPConfigurations of the NetworkInterface - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | Gets or sets DNS Settings in NetworkInterface - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | Gets the MAC Address of the network interface | -| primary | boolean | No | Gets whether this is a primary NIC on a virtual machine | -| enableIPForwarding | boolean | No | Gets or sets whether IPForwarding is enabled on the NIC | -| resourceGuid | string | No | Gets or sets resource guid property of the network interface resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| ipConfiguration | object | No | [IPConfiguration object](#IPConfiguration) | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | -| appliedDnsServers | array | No | Gets or sets list of Applied DNS servers IP addresses - string | -| internalDnsNameLabel | string | No | Gets or sets the Internal DNS name | -| internalFqdn | string | No | Gets or sets the internal fqdn. | -| internalDomainNameSuffix | string | No | Gets or sets internal domain name suffix of the NIC. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | Gets or Sests 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. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Gets or sets the backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| loadBalancingRules | array | No | Gets Load Balancing rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| outboundNatRule | object | No | Gets outbound rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendIPConfiguration | object | No | Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| protocol | enum | No | Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | Gets or sets the port for the external endpoint. You can spcify 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 | -| backendPort | integer | No | 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 compotnent 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 | -| idleTimeoutInMinutes | integer | No | 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 emlement is only used when the protocol is set to Tcp | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Gets or sets the dns name | -| ipAddress | string | No | Gets or sets the ip address | - diff --git a/test/Resource/Expected/Network/2016-03-30/routeTables/routes.md b/test/Resource/Expected/Network/2016-03-30/routeTables/routes.md deleted file mode 100644 index 1b99c78..0000000 --- a/test/Resource/Expected/Network/2016-03-30/routeTables/routes.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Network/routeTables/routes template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/routeTables/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables/routes", - "apiVersion": "2016-03-30", - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables/routes | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| properties | object | Yes | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-03-30/virtualNetworkGateways.md b/test/Resource/Expected/Network/2016-03-30/virtualNetworkGateways.md deleted file mode 100644 index e06e87b..0000000 --- a/test/Resource/Expected/Network/2016-03-30/virtualNetworkGateways.md +++ /dev/null @@ -1,215 +0,0 @@ -# Microsoft.Network/virtualNetworkGateways template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/virtualNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworkGateways", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworkGateways | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IpConfigurations for Virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. - PolicyBased or RouteBased | -| enableBgp | boolean | No | EnableBgp Flag | -| gatewayDefaultSite | object | No | Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | Gets or sets resource guid property of the VirtualNetworkGateway resource | -| provisioningState | string | No | Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway sku name -Basic/HighPerformance/Standard. - Basic, HighPerformance, Standard | -| tier | enum | No | Gateway sku tier -Basic/HighPerformance/Standard. - Basic, HighPerformance, Standard | -| capacity | integer | No | The capacity | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for Virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | Gets or sets this BGP speaker's ASN | -| bgpPeeringAddress | string | No | Gets or sets the BGP peering address and BGP identifier of this BGP speaker | -| peerWeight | integer | No | Gets or sets the weight added to routes learned from this BGP speaker | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | Gets or sets List of address blocks reserved for this virtual network in CIDR notation - string | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | No | Gets or sets the certificate public data | -| provisioningState | string | No | Gets or sets Provisioning state of the VPN client root certificate resource Updating/Deleting/Failed | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | Gets or sets the revoked Vpn client certificate thumbprint | -| provisioningState | string | No | Gets or sets Provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-03-30/virtualNetworks.md b/test/Resource/Expected/Network/2016-03-30/virtualNetworks.md deleted file mode 100644 index 6ec976a..0000000 --- a/test/Resource/Expected/Network/2016-03-30/virtualNetworks.md +++ /dev/null @@ -1,636 +0,0 @@ -# Microsoft.Network/virtualNetworks template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/virtualNetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks", - "apiVersion": "2016-03-30", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "addressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "string" - ] - }, - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": "Subnet", - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - "Subnet" - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": "Subnet", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualNetworkPropertiesFormat object](#VirtualNetworkPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | -| resources | array | No | [subnets](./virtualNetworks/subnets.md) | - - - -### VirtualNetworkPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressSpace | object | No | Gets or sets AddressSpace that contains an array of IP address ranges that can be used by subnets - [AddressSpace object](#AddressSpace) | -| dhcpOptions | object | No | Gets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtual network - [DhcpOptions object](#DhcpOptions) | -| subnets | array | No | Gets or sets List of subnets in a VirtualNetwork - [Subnet object](#Subnet) | -| resourceGuid | string | No | Gets or sets resource guid property of the VirtualNetwork resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | Gets or sets List of address blocks reserved for this virtual network in CIDR notation - string | - - - -### DhcpOptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| ipConfigurations | array | No | Gets array of references to the network interface IP configurations using subnet - [IPConfiguration object](#IPConfiguration) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### IPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [IPConfigurationPropertiesFormat object](#IPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets Security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or sets Default security rules of network security group - [SecurityRule object](#SecurityRule) | -| networkInterfaces | array | No | Gets collection of references to Network Interfaces - [NetworkInterface object](#NetworkInterface) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### IPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterface object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | Gets or sets the reference of a VirtualMachine - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | Gets or sets list of IPConfigurations of the NetworkInterface - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | Gets or sets DNS Settings in NetworkInterface - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | Gets the MAC Address of the network interface | -| primary | boolean | No | Gets whether this is a primary NIC on a virtual machine | -| enableIPForwarding | boolean | No | Gets or sets whether IPForwarding is enabled on the NIC | -| resourceGuid | string | No | Gets or sets resource guid property of the network interface resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| ipConfiguration | object | No | [IPConfiguration object](#IPConfiguration) | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | -| appliedDnsServers | array | No | Gets or sets list of Applied DNS servers IP addresses - string | -| internalDnsNameLabel | string | No | Gets or sets the Internal DNS name | -| internalFqdn | string | No | Gets or sets the internal fqdn. | -| internalDomainNameSuffix | string | No | Gets or sets internal domain name suffix of the NIC. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | Gets or Sests 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. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Gets or sets the backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| loadBalancingRules | array | No | Gets Load Balancing rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| outboundNatRule | object | No | Gets outbound rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendIPConfiguration | object | No | Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| protocol | enum | No | Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | Gets or sets the port for the external endpoint. You can spcify 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 | -| backendPort | integer | No | 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 compotnent 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 | -| idleTimeoutInMinutes | integer | No | 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 emlement is only used when the protocol is set to Tcp | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Gets or sets the dns name | -| ipAddress | string | No | Gets or sets the ip address | - diff --git a/test/Resource/Expected/Network/2016-03-30/virtualNetworks/subnets.md b/test/Resource/Expected/Network/2016-03-30/virtualNetworks/subnets.md deleted file mode 100644 index 940b0b5..0000000 --- a/test/Resource/Expected/Network/2016-03-30/virtualNetworks/subnets.md +++ /dev/null @@ -1,609 +0,0 @@ -# Microsoft.Network/virtualNetworks/subnets template reference -API Version: 2016-03-30 -## Template format - -To create a Microsoft.Network/virtualNetworks/subnets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/subnets", - "apiVersion": "2016-03-30", - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "networkInterfaces": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": "NetworkSecurityGroup", - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "loadBalancingRules": [ - { - "id": "string" - } - ], - "outboundNatRule": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendIPConfiguration": "NetworkInterfaceIPConfiguration", - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": "SubnetPropertiesFormat", - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": "SubnetPropertiesFormat", - "name": "string", - "etag": "string" - }, - "publicIPAddress": "PublicIPAddress", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - } - ], - "subnets": [ - { - "id": "string", - "properties": "SubnetPropertiesFormat", - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "subnets": [ - { - "id": "string", - "properties": "SubnetPropertiesFormat", - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": "SubnetPropertiesFormat", - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "ipConfiguration": "IPConfiguration", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/subnets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/subnets | -| apiVersion | enum | Yes | 2016-03-30 | -| id | string | No | Resource Id | -| properties | object | Yes | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| ipConfigurations | array | No | Gets array of references to the network interface IP configurations using subnet - [IPConfiguration object](#IPConfiguration) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### IPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [IPConfigurationPropertiesFormat object](#IPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets Security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or sets Default security rules of network security group - [SecurityRule object](#SecurityRule) | -| networkInterfaces | array | No | Gets collection of references to Network Interfaces - [NetworkInterface object](#NetworkInterface) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| subnets | array | No | Gets collection of references to subnets - [Subnet object](#Subnet) | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### IPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterface object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | Gets or sets the reference of a VirtualMachine - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | Gets or sets list of IPConfigurations of the NetworkInterface - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | Gets or sets DNS Settings in NetworkInterface - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | Gets the MAC Address of the network interface | -| primary | boolean | No | Gets whether this is a primary NIC on a virtual machine | -| enableIPForwarding | boolean | No | Gets or sets whether IPForwarding is enabled on the NIC | -| resourceGuid | string | No | Gets or sets resource guid property of the network interface resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets or sets Provisioning state of the resource Updating/Deleting/Failed | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| ipConfiguration | object | No | [IPConfiguration object](#IPConfiguration) | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | -| appliedDnsServers | array | No | Gets or sets list of Applied DNS servers IP addresses - string | -| internalDnsNameLabel | string | No | Gets or sets the Internal DNS name | -| internalFqdn | string | No | Gets or sets the internal fqdn. | -| internalDomainNameSuffix | string | No | Gets or sets internal domain name suffix of the NIC. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | Gets or Sests 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. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Gets or sets the backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Gets collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| loadBalancingRules | array | No | Gets Load Balancing rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| outboundNatRule | object | No | Gets outbound rules that use this Backend Address Pool - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendIPConfiguration | object | No | Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| protocol | enum | No | Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | Gets or sets the port for the external endpoint. You can spcify 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 | -| backendPort | integer | No | 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 compotnent 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 | -| idleTimeoutInMinutes | integer | No | 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 emlement is only used when the protocol is set to Tcp | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Gets or sets the dns name | -| ipAddress | string | No | Gets or sets the ip address | - diff --git a/test/Resource/Expected/Network/2016-06-01/Microsoft.Network.json b/test/Resource/Expected/Network/2016-06-01/Microsoft.Network.json deleted file mode 100644 index 4307c6a..0000000 --- a/test/Resource/Expected/Network/2016-06-01/Microsoft.Network.json +++ /dev/null @@ -1,5462 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-06-01/Microsoft.Network.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Network", - "description": "Microsoft Network Resource Types", - "resourceDefinitions": { - "applicationGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationGateways" - }, - "connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/connections" - }, - "expressRouteCircuits": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets sku" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/expressRouteCircuits_authorizations_childResource" - }, - { - "$ref": "#/definitions/expressRouteCircuits_peerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits" - }, - "expressRouteCircuits_authorizations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "loadBalancers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers" - }, - "localNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/localNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/localNetworkGateways" - }, - "networkInterfaces": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkInterfaces" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkInterfaces" - }, - "networkSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkSecurityGroups_securityRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups" - }, - "networkSecurityGroups_securityRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups/securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "publicIPAddresses": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/publicIPAddresses" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/publicIPAddresses" - }, - "routeTables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeTables_routes_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables" - }, - "routeTables_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "virtualNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworkGateways" - }, - "virtualNetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualNetworks_subnets_childResource" - }, - { - "$ref": "#/definitions/virtualNetworks_virtualNetworkPeerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks" - }, - "virtualNetworks_subnets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - } - }, - "definitions": { - "AddressSpace": { - "type": "object", - "properties": { - "addressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of address blocks reserved for this virtual network in CIDR notation" - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets" - }, - "ApplicationGatewayAuthenticationCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Authentication certificates of application gateway" - }, - "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Certificate public data " - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the authentication certificate resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Authentication certificates of application gateway" - }, - "ApplicationGatewayBackendAddress": { - "type": "object", - "properties": { - "fqdn": { - "type": "string", - "description": "Dns name" - }, - "ipAddress": { - "type": "string", - "description": "Ip address" - } - }, - "description": "Backend Address of application gateway" - }, - "ApplicationGatewayBackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Backend Address Pool of application gateway" - }, - "ApplicationGatewayBackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of references to IPs defined in NICs" - }, - "backendAddresses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddress" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend addresses" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend address pool resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Backend Address Pool of application gateway" - }, - "ApplicationGatewayBackendHttpSettings": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Backend address pool settings of application gateway" - }, - "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Port" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "cookieBasedAffinity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cookie affinity." - }, - "requestTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request timeout" - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probe resource of application gateway " - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of references to Application Gateway Authentication Certificates" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Backend address pool settings of application gateway" - }, - "ApplicationGatewayFrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Frontend IP configuration of application gateway" - }, - "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "PrivateIPAddress of the Network Interface IP Configuration" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PrivateIP allocation method (Static/Dynamic)." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource" - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the PublicIP resource" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Frontend IP configuration of application gateway" - }, - "ApplicationGatewayFrontendPort": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Frontend Port of application gateway" - }, - "ApplicationGatewayFrontendPortPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the frontend port resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Frontend Port of application gateway" - }, - "ApplicationGatewayHttpListener": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Http listener of application gateway" - }, - "ApplicationGatewayHttpListenerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP configuration resource of application gateway " - }, - "frontendPort": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of application gateway " - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "hostName": { - "type": "string", - "description": "Host name of http listener " - }, - "sslCertificate": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ssl certificate resource of application gateway " - }, - "requireServerNameIndication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "RequireServerNameIndication of http listener " - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the http listener resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Http listener of application gateway" - }, - "ApplicationGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "IP configuration of application gateway" - }, - "ApplicationGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address " - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway subnet resource Updating/Deleting/Failed" - } - }, - "description": "Properties of IP configuration of application gateway" - }, - "ApplicationGatewayPathRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Path rule of URL path map of application gateway" - }, - "ApplicationGatewayPathRulePropertiesFormat": { - "type": "object", - "properties": { - "paths": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules of URL path map" - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of URL path map " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings resource of URL path map " - }, - "provisioningState": { - "type": "string", - "description": "Path rule of URL path map resource Updating/Deleting/Failed" - } - }, - "description": "Properties of probe of application gateway" - }, - "ApplicationGatewayProbe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Probe of application gateway" - }, - "ApplicationGatewayProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "host": { - "type": "string", - "description": "Host to send probe to " - }, - "path": { - "type": "string", - "description": "Relative path of probe " - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probing interval in seconds " - }, - "timeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probing timeout in seconds " - }, - "unhealthyThreshold": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probing unhealthy threshold " - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource Updating/Deleting/Failed" - } - }, - "description": "Properties of probe of application gateway" - }, - "ApplicationGatewayPropertiesFormat": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sku of application gateway resource" - }, - "sslPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL policy of application gateway resource" - }, - "gatewayIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnets of application gateway resource" - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Authentication certificates of application gateway resource" - }, - "sslCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewaySslCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificates of application gateway resource" - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP addresses of application gateway resource" - }, - "frontendPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendPort" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend ports of application gateway resource" - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayProbe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probes of application gateway resource" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool of application gateway resource" - }, - "backendHttpSettingsCollection": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings of application gateway resource" - }, - "httpListeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayHttpListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HTTP listeners of application gateway resource" - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayUrlPathMap" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map of application gateway resource" - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing rules of application gateway resource" - }, - "resourceGuid": { - "type": "string", - "description": "Resource guid property of the ApplicationGateway resource" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Application Gateway" - }, - "ApplicationGatewayRequestRoutingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Request routing rule of application gateway" - }, - "ApplicationGatewayRequestRoutingRulePropertiesFormat": { - "type": "object", - "properties": { - "ruleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "PathBasedRouting" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Rule type." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of application gateway " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of application gateway " - }, - "httpListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listener resource of application gateway " - }, - "urlPathMap": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Url path map resource of application gateway " - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the request routing rule resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Request routing rule of application gateway" - }, - "ApplicationGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_Small", - "Standard_Medium", - "Standard_Large" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of application gateway SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tier of application gateway." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity (instance count) of application gateway" - } - }, - "description": "SKU of application gateway" - }, - "ApplicationGatewaySslCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "SSL certificates of application gateway" - }, - "ApplicationGatewaySslCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "SSL Certificate data " - }, - "password": { - "type": "string", - "description": "SSL Certificate password " - }, - "publicCertData": { - "type": "string", - "description": "SSL Certificate public data " - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the ssl certificate resource Updating/Deleting/Failed" - } - }, - "description": "Properties of SSL certificates of application gateway" - }, - "ApplicationGatewaySslPolicy": { - "type": "object", - "properties": { - "disabledSslProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL protocols to be disabled on Application Gateway" - } - }, - "description": "Application gateway SSL policy" - }, - "ApplicationGatewayUrlPathMap": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "UrlPathMap of application gateway" - }, - "ApplicationGatewayUrlPathMapPropertiesFormat": { - "type": "object", - "properties": { - "defaultBackendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend address pool resource of URL path map " - }, - "defaultBackendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend http settings resource of URL path map " - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayPathRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rule of URL path map resource" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource Updating/Deleting/Failed" - } - }, - "description": "Properties of UrlPathMap of application gateway" - }, - "AuthorizationPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "Gets or sets the authorization key" - }, - "authorizationUseStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Available", - "InUse" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets AuthorizationUseStatus." - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - } - }, - "BackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Pool of backend IP addresses" - }, - "BackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "description": "Get provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of BackendAddressPool" - }, - "BgpSettings": { - "type": "object", - "properties": { - "asn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets this BGP speaker's ASN" - }, - "bgpPeeringAddress": { - "type": "string", - "description": "Gets or sets the BGP peering address and BGP identifier of this BGP speaker" - }, - "peerWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the weight added to routes learned from this BGP speaker" - } - } - }, - "DhcpOptions": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of DNS servers IP addresses" - } - }, - "description": "DHCPOptions contains an array of DNS servers available to VMs deployed in the virtual networkStandard DHCP option for a subnet overrides VNET DHCP options." - }, - "ExpressRouteCircuitAuthorization": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Authorization in a ExpressRouteCircuit resource" - }, - "ExpressRouteCircuitPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Peering in a ExpressRouteCircuit resource" - }, - "ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "advertisedPublicPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of AdvertisedPublicPrefixes" - }, - "advertisedPublicPrefixesState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotConfigured", - "Configuring", - "Configured", - "ValidationNeeded" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets AdvertisedPublicPrefixState of the Peering resource." - }, - "customerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or Sets CustomerAsn of the peering." - }, - "routingRegistryName": { - "type": "string", - "description": "Gets or Sets RoutingRegistryName of the config." - } - }, - "description": "Specifies the peering config" - }, - "ExpressRouteCircuitPeeringPropertiesFormat": { - "type": "object", - "properties": { - "peeringType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzurePublicPeering", - "AzurePrivatePeering", - "MicrosoftPeering" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PeeringType." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets state of Peering." - }, - "azureASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the azure ASN" - }, - "peerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the peer ASN" - }, - "primaryPeerAddressPrefix": { - "type": "string", - "description": "Gets or sets the primary address prefix" - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "Gets or sets the secondary address prefix" - }, - "primaryAzurePort": { - "type": "string", - "description": "Gets or sets the primary port" - }, - "secondaryAzurePort": { - "type": "string", - "description": "Gets or sets the secondary port" - }, - "sharedKey": { - "type": "string", - "description": "Gets or sets the shared key" - }, - "vlanId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the vlan id" - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the mircosoft peering config" - }, - "stats": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitStats" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or peering stats" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - }, - "gatewayManagerEtag": { - "type": "string", - "description": "Gets or sets the GatewayManager Etag" - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets whether the provider or the customer last modified the peering" - } - } - }, - "ExpressRouteCircuitPropertiesFormat": { - "type": "object", - "properties": { - "allowClassicOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "allow classic operations" - }, - "circuitProvisioningState": { - "type": "string", - "description": "Gets or sets CircuitProvisioningState state of the resource " - }, - "serviceProviderProvisioningState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotProvisioned", - "Provisioning", - "Provisioned", - "Deprovisioning" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets ServiceProviderProvisioningState state of the resource." - }, - "authorizations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitAuthorization" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of authorizations" - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of peerings" - }, - "serviceKey": { - "type": "string", - "description": "Gets or sets ServiceKey" - }, - "serviceProviderNotes": { - "type": "string", - "description": "Gets or sets ServiceProviderNotes" - }, - "serviceProviderProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets ServiceProviderProperties" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - }, - "gatewayManagerEtag": { - "type": "string", - "description": "Gets or sets the GatewayManager Etag" - } - }, - "description": "Properties of ExpressRouteCircuit" - }, - "ExpressRouteCircuitServiceProviderProperties": { - "type": "object", - "properties": { - "serviceProviderName": { - "type": "string", - "description": "Gets or sets serviceProviderName." - }, - "peeringLocation": { - "type": "string", - "description": "Gets or sets peering location." - }, - "bandwidthInMbps": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets BandwidthInMbps." - } - }, - "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit" - }, - "ExpressRouteCircuitSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets name of the sku." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets tier of the sku." - }, - "family": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UnlimitedData", - "MeteredData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets family of the sku." - } - }, - "description": "Contains sku in an ExpressRouteCircuit" - }, - "ExpressRouteCircuitStats": { - "type": "object", - "properties": { - "primarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "primarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - }, - "secondarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "secondarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - } - }, - "description": "Contains Stats associated with the peering" - }, - "expressRouteCircuits_authorizations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "FrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Frontend IP address of the load balancer" - }, - "FrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "Gets or sets the privateIPAddress of the IP Configuration" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP allocation method." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the subnet resource" - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the PublicIP resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Frontend IP Configuration of the load balancer" - }, - "InboundNatPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Inbound NAT pool of the load balancer" - }, - "InboundNatPoolPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to frontend IP Addresses" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the transport protocol for the endpoint. Possible values are Udp or Tcp." - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "protocol", - "frontendPortRangeStart", - "frontendPortRangeEnd", - "backendPort" - ], - "description": "Properties of Inbound NAT pool" - }, - "InboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Inbound NAT rule of the loadbalancer" - }, - "InboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to frontend IP Addresses" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the transport protocol for the endpoint. Possible values are Udp or Tcp." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual 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" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Inbound NAT rule" - }, - "LoadBalancerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/FrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets frontend IP addresses of the load balancer" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Pools of backend IP addresses" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets load balancing rules" - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Probe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of Load balancer probes" - }, - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of inbound rules" - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets inbound NAT pools" - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/OutboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets outbound NAT rules" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the Load balancer resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of Load Balancer" - }, - "LoadBalancingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Rules of the load balancer" - }, - "LoadBalancingRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to frontend IP Addresses" - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs" - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the load balancer probe used by the Load Balancing rule." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp." - }, - "loadDistribution": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "SourceIP", - "SourceIPProtocol" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the load distribution policy for this rule." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual 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" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "protocol", - "frontendPort" - ], - "description": "Properties of the load balancer" - }, - "LocalNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "A common class for general resource information" - }, - "LocalNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "localNetworkAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network site Address space" - }, - "gatewayIpAddress": { - "type": "string", - "description": "IP address of local network gateway." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network gateway's BGP speaker settings" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the LocalNetworkGateway resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed" - } - }, - "description": "LocalNetworkGateway properties" - }, - "NetworkInterfaceDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of DNS servers IP addresses" - }, - "appliedDnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of Applied DNS servers IP addresses" - }, - "internalDnsNameLabel": { - "type": "string", - "description": "Gets or sets the internal DNS name" - }, - "internalFqdn": { - "type": "string", - "description": "Gets or sets the internal fqdn." - }, - "internalDomainNameSuffix": { - "type": "string", - "description": "Gets or sets internal domain name suffix of the NIC." - } - }, - "description": "Dns settings of a network interface" - }, - "NetworkInterfaceIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "IPConfiguration in a NetworkInterface" - }, - "NetworkInterfaceIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of ApplicationGatewayBackendAddressPool resource" - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of LoadBalancerBackendAddressPool resource" - }, - "loadBalancerInboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of references of LoadBalancerInboundNatRules" - }, - "privateIPAddress": { - "type": "string" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP allocation method." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP address version (IPv4/IPv6)." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary customer address on the NIC" - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "provisioningState": { - "type": "string" - } - }, - "description": "Properties of IPConfiguration" - }, - "NetworkInterfacePropertiesFormat": { - "type": "object", - "properties": { - "virtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of a VirtualMachine" - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the NetworkSecurityGroup resource" - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of IPConfigurations of the network interface" - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets DNS settings in network interface" - }, - "macAddress": { - "type": "string", - "description": "Gets the MAC address of the network interface" - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary NIC on a virtual machine" - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets whether IPForwarding is enabled on the NIC" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the network interface resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "NetworkInterface properties. " - }, - "NetworkSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "NetworkSecurityGroup resource" - }, - "NetworkSecurityGroupPropertiesFormat": { - "type": "object", - "properties": { - "securityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets security rules of network security group" - }, - "defaultSecurityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or default security rules of network security group" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the network security group resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Network Security Group resource" - }, - "networkSecurityGroups_securityRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "OutboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OutboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Outbound NAT pool of the load balancer" - }, - "OutboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "allocatedOutboundPorts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the number of outbound ports to be used for SNAT" - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Frontend IP addresses of the load balancer" - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "backendAddressPool" - ], - "description": "Outbound NAT pool of the load balancer" - }, - "Probe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Load balancer Probe" - }, - "ProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive." - }, - "intervalInSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "numberOfProbes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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. " - }, - "requestPath": { - "type": "string", - "description": "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" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "protocol", - "port" - ] - }, - "PublicIPAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "PublicIPAddress resource" - }, - "PublicIPAddressDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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. " - } - }, - "description": "Contains FQDN of the DNS record associated with the public IP address" - }, - "PublicIPAddressPropertiesFormat": { - "type": "object", - "properties": { - "publicIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PublicIP allocation method (Static/Dynamic)." - }, - "publicIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PublicIP address version (IPv4/IPv6)." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets FQDN of the DNS record associated with the public IP address" - }, - "ipAddress": { - "type": "string" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the Idletimeout of the public IP address" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the PublicIP resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "PublicIpAddress properties" - }, - "ResourceNavigationLink": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceNavigationLinkFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource" - } - }, - "description": "ResourceNavigationLink resource" - }, - "ResourceNavigationLinkFormat": { - "type": "object", - "properties": { - "linkedResourceType": { - "type": "string", - "description": "Resource type of the linked resource" - }, - "link": { - "type": "string", - "description": "Link to the external resource" - } - }, - "description": "Properties of ResourceNavigationLink" - }, - "Route": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Route resource" - }, - "RoutePropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "Gets or sets the destination CIDR to which the route applies." - }, - "nextHopType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VirtualNetworkGateway", - "VnetLocal", - "Internet", - "VirtualAppliance", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the type of Azure hop the packet should be sent to." - }, - "nextHopIpAddress": { - "type": "string", - "description": "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." - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the resource Updating/Deleting/Failed" - } - }, - "required": [ - "nextHopType" - ], - "description": "Route resource" - }, - "RouteTable": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "RouteTable resource" - }, - "RouteTablePropertiesFormat": { - "type": "object", - "properties": { - "routes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Route" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Routes in a Route Table" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the resource Updating/Deleting/Failed" - } - }, - "description": "Route Table resource" - }, - "routeTables_routes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "SecurityRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Network security rule" - }, - "SecurityRulePropertiesFormat": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Gets or sets a description for this rule. Restricted to 140 chars." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp", - "*" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*)." - }, - "sourcePortRange": { - "type": "string", - "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "destinationPortRange": { - "type": "string", - "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "sourceAddressPrefix": { - "type": "string", - "description": "Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " - }, - "destinationAddressPrefix": { - "type": "string", - "description": "Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. " - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'." - }, - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic." - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "required": [ - "protocol", - "sourceAddressPrefix", - "destinationAddressPrefix", - "access", - "direction" - ] - }, - "Subnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Subnet in a VirtualNework resource" - }, - "SubnetPropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "Gets or sets Address prefix for the subnet." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the NetworkSecurityGroup resource" - }, - "routeTable": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTable" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the RouteTable resource" - }, - "resourceNavigationLinks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceNavigationLink" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets array of references to the external resources using subnet" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the resource" - } - } - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - } - }, - "VirtualNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated" - } - }, - "description": "A common class for general resource information" - }, - "VirtualNetworkGatewayConnectionPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorizationKey." - }, - "virtualNetworkGateway1": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "virtualNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "localNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "connectionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPsec", - "Vnet2Vnet", - "ExpressRoute", - "VPNClient" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway connection type -Ipsec/Dedicated/VpnClient/Vnet2Vnet." - }, - "routingWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Routing weight." - }, - "sharedKey": { - "type": "string", - "description": "The Ipsec share key." - }, - "connectionStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Unknown", - "Connecting", - "Connected", - "NotConnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network Gateway connection status." - }, - "egressBytesTransferred": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Egress Bytes Transferred in this connection" - }, - "ingressBytesTransferred": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Ingress Bytes Transferred in this connection" - }, - "peer": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to peerings resource." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp Flag" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed" - } - }, - "description": "VirtualNetworkGatewayConnection properties" - }, - "VirtualNetworkGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "IpConfiguration for Virtual network gateway" - }, - "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets PrivateIP allocation method." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the subnet resource" - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the PublicIP resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - }, - "description": "Properties of VirtualNetworkGatewayIPConfiguration" - }, - "VirtualNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IpConfigurations for Virtual network gateway." - }, - "gatewayType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Vpn", - "ExpressRoute" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PolicyBased", - "RouteBased" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp Flag" - }, - "activeActive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "ActiveActive flag" - }, - "gatewayDefaultSite": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway." - }, - "vpnClientConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network gateway's BGP speaker settings" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the VirtualNetworkGateway resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed" - } - }, - "description": "VirtualNetworkGateway properties" - }, - "VirtualNetworkGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway sku name -Basic/HighPerformance/Standard/UltraPerformance." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway sku tier -Basic/HighPerformance/Standard/UltraPerformance." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity" - } - }, - "description": "VirtualNetworkGatewaySku details" - }, - "VirtualNetworkPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "Peerings in a VirtualNework resource" - }, - "VirtualNetworkPeeringPropertiesFormat": { - "type": "object", - "properties": { - "allowVirtualNetworkAccess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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" - }, - "allowForwardedTraffic": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed" - }, - "allowGatewayTransit": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets if gatewayLinks can be used in remote virtual network’s link to this virtual network" - }, - "useRemoteGateways": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "remoteVirtualNetwork": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the remote virtual network" - }, - "peeringState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Initiated", - "Connected", - "Disconnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets the status of the virtual network peering." - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the resource" - } - } - }, - "VirtualNetworkPropertiesFormat": { - "type": "object", - "properties": { - "addressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets AddressSpace that contains an array of IP address ranges that can be used by subnets" - }, - "dhcpOptions": { - "oneOf": [ - { - "$ref": "#/definitions/DhcpOptions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtual network" - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of subnets in a VirtualNetwork" - }, - "VirtualNetworkPeerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets list of peerings in a VirtualNetwork" - }, - "resourceGuid": { - "type": "string", - "description": "Gets or sets resource guid property of the VirtualNetwork resource" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the PublicIP resource Updating/Deleting/Failed" - } - } - }, - "virtualNetworks_subnets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - }, - "VpnClientConfiguration": { - "type": "object", - "properties": { - "vpnClientAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient." - }, - "vpnClientRootCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRootCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRootCertificate for Virtual network gateway." - }, - "vpnClientRevokedCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRevokedCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRevokedCertificate for Virtual network gateway." - } - }, - "description": "VpnClientConfiguration for P2S client" - }, - "VpnClientRevokedCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "VPN client revoked certificate of virtual network gateway" - }, - "VpnClientRevokedCertificatePropertiesFormat": { - "type": "object", - "properties": { - "thumbprint": { - "type": "string", - "description": "Gets or sets the revoked Vpn client certificate thumbprint" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed" - } - }, - "description": "Properties of the revoked VPN client certificate of virtual network gateway" - }, - "VpnClientRootCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated" - } - }, - "description": "VPN client root certificate of virtual network gateway" - }, - "VpnClientRootCertificatePropertiesFormat": { - "type": "object", - "properties": { - "publicCertData": { - "type": "string", - "description": "Gets or sets the certificate public data" - }, - "provisioningState": { - "type": "string", - "description": "Gets provisioning state of the VPN client root certificate resource Updating/Deleting/Failed" - } - }, - "description": "Properties of SSL certificates of application gateway" - } - } -} diff --git a/test/Resource/Expected/Network/2016-06-01/applicationGateways.md b/test/Resource/Expected/Network/2016-06-01/applicationGateways.md deleted file mode 100644 index 5514df3..0000000 --- a/test/Resource/Expected/Network/2016-06-01/applicationGateways.md +++ /dev/null @@ -1,921 +0,0 @@ -# Microsoft.Network/applicationGateways template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/applicationGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationGateways", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": { - "name": "string", - "tier": "Standard", - "capacity": "integer" - }, - "sslPolicy": { - "disabledSslProtocols": [ - "string" - ] - }, - "gatewayIPConfigurations": [ - { - "id": "string", - "properties": { - "subnet": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "authenticationCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "sslCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "password": "string", - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendPorts": [ - { - "id": "string", - "properties": { - "port": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "host": "string", - "path": "string", - "interval": "integer", - "timeout": "integer", - "unhealthyThreshold": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - "ApplicationGatewayBackendAddressPool" - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendHttpSettingsCollection": [ - { - "id": "string", - "properties": { - "port": "integer", - "protocol": "string", - "cookieBasedAffinity": "string", - "requestTimeout": "integer", - "probe": { - "id": "string" - }, - "authenticationCertificates": [ - { - "id": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "httpListeners": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "frontendPort": { - "id": "string" - }, - "protocol": "string", - "hostName": "string", - "sslCertificate": { - "id": "string" - }, - "requireServerNameIndication": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "urlPathMaps": [ - { - "id": "string", - "properties": { - "defaultBackendAddressPool": { - "id": "string" - }, - "defaultBackendHttpSettings": { - "id": "string" - }, - "pathRules": [ - { - "id": "string", - "properties": { - "paths": [ - "string" - ], - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "requestRoutingRules": [ - { - "id": "string", - "properties": { - "ruleType": "string", - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "httpListener": { - "id": "string" - }, - "urlPathMap": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationGateways | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [ApplicationGatewayPropertiesFormat object](#ApplicationGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | Sku of application gateway resource - [ApplicationGatewaySku object](#ApplicationGatewaySku) | -| sslPolicy | object | No | SSL policy of application gateway resource - [ApplicationGatewaySslPolicy object](#ApplicationGatewaySslPolicy) | -| gatewayIPConfigurations | array | No | Subnets of application gateway resource - [ApplicationGatewayIPConfiguration object](#ApplicationGatewayIPConfiguration) | -| authenticationCertificates | array | No | Authentication certificates of application gateway resource - [ApplicationGatewayAuthenticationCertificate object](#ApplicationGatewayAuthenticationCertificate) | -| sslCertificates | array | No | SSL certificates of application gateway resource - [ApplicationGatewaySslCertificate object](#ApplicationGatewaySslCertificate) | -| frontendIPConfigurations | array | No | Frontend IP addresses of application gateway resource - [ApplicationGatewayFrontendIPConfiguration object](#ApplicationGatewayFrontendIPConfiguration) | -| frontendPorts | array | No | Frontend ports of application gateway resource - [ApplicationGatewayFrontendPort object](#ApplicationGatewayFrontendPort) | -| probes | array | No | Probes of application gateway resource - [ApplicationGatewayProbe object](#ApplicationGatewayProbe) | -| backendAddressPools | array | No | Backend address pool of application gateway resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| backendHttpSettingsCollection | array | No | Backend http settings of application gateway resource - [ApplicationGatewayBackendHttpSettings object](#ApplicationGatewayBackendHttpSettings) | -| httpListeners | array | No | HTTP listeners of application gateway resource - [ApplicationGatewayHttpListener object](#ApplicationGatewayHttpListener) | -| urlPathMaps | array | No | URL path map of application gateway resource - [ApplicationGatewayUrlPathMap object](#ApplicationGatewayUrlPathMap) | -| requestRoutingRules | array | No | Request routing rules of application gateway resource - [ApplicationGatewayRequestRoutingRule object](#ApplicationGatewayRequestRoutingRule) | -| resourceGuid | string | No | Resource guid property of the ApplicationGateway resource | -| provisioningState | string | No | Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed | - - - -### ApplicationGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of application gateway SKU. - Standard_Small, Standard_Medium, Standard_Large | -| tier | enum | No | Tier of application gateway. - Standard | -| capacity | integer | No | Capacity (instance count) of application gateway | - - - -### ApplicationGatewaySslPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disabledSslProtocols | array | No | SSL protocols to be disabled on Application Gateway - TLSv1_0, TLSv1_1, TLSv1_2 | - - - -### ApplicationGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayIPConfigurationPropertiesFormat object](#ApplicationGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayAuthenticationCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayAuthenticationCertificatePropertiesFormat object](#ApplicationGatewayAuthenticationCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewaySslCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewaySslCertificatePropertiesFormat object](#ApplicationGatewaySslCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayFrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayFrontendIPConfigurationPropertiesFormat object](#ApplicationGatewayFrontendIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayFrontendPort object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayFrontendPortPropertiesFormat object](#ApplicationGatewayFrontendPortPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayProbe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayProbePropertiesFormat object](#ApplicationGatewayProbePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendHttpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendHttpSettingsPropertiesFormat object](#ApplicationGatewayBackendHttpSettingsPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayHttpListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayHttpListenerPropertiesFormat object](#ApplicationGatewayHttpListenerPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayUrlPathMap object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayUrlPathMapPropertiesFormat object](#ApplicationGatewayUrlPathMapPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayRequestRoutingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayRequestRoutingRulePropertiesFormat object](#ApplicationGatewayRequestRoutingRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Reference of the subnet resource. A subnet from where application gateway gets its private address - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the application gateway subnet resource Updating/Deleting/Failed | - - - -### ApplicationGatewayAuthenticationCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Certificate public data | -| provisioningState | string | No | Provisioning state of the authentication certificate resource Updating/Deleting/Failed | - - - -### ApplicationGatewaySslCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | SSL Certificate data | -| password | string | No | SSL Certificate password | -| publicCertData | string | No | SSL Certificate public data | -| provisioningState | string | No | Provisioning state of the ssl certificate resource Updating/Deleting/Failed | - - - -### ApplicationGatewayFrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | PrivateIPAddress of the Network Interface IP Configuration | -| privateIPAllocationMethod | enum | No | PrivateIP allocation method (Static/Dynamic). - Static or Dynamic | -| subnet | object | No | Reference of the subnet resource - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Reference of the PublicIP resource - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayFrontendPortPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Frontend port | -| provisioningState | string | No | Provisioning state of the frontend port resource Updating/Deleting/Failed | - - - -### ApplicationGatewayProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol. - Http or Https | -| host | string | No | Host to send probe to | -| path | string | No | Relative path of probe | -| interval | integer | No | Probing interval in seconds | -| timeout | integer | No | Probing timeout in seconds | -| unhealthyThreshold | integer | No | Probing unhealthy threshold | -| provisioningState | string | No | Provisioning state of the backend http settings resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendHttpSettingsPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Port | -| protocol | enum | No | Protocol. - Http or Https | -| cookieBasedAffinity | enum | No | Cookie affinity. - Enabled or Disabled | -| requestTimeout | integer | No | Request timeout | -| probe | object | No | Probe resource of application gateway - [SubResource object](#SubResource) | -| authenticationCertificates | array | No | Array of references to Application Gateway Authentication Certificates - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the backend http settings resource Updating/Deleting/Failed | - - - -### ApplicationGatewayHttpListenerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Frontend IP configuration resource of application gateway - [SubResource object](#SubResource) | -| frontendPort | object | No | Frontend port resource of application gateway - [SubResource object](#SubResource) | -| protocol | enum | No | Protocol. - Http or Https | -| hostName | string | No | Host name of http listener | -| sslCertificate | object | No | Ssl certificate resource of application gateway - [SubResource object](#SubResource) | -| requireServerNameIndication | boolean | No | RequireServerNameIndication of http listener | -| provisioningState | string | No | Provisioning state of the http listener resource Updating/Deleting/Failed | - - - -### ApplicationGatewayUrlPathMapPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultBackendAddressPool | object | No | Default backend address pool resource of URL path map - [SubResource object](#SubResource) | -| defaultBackendHttpSettings | object | No | Default backend http settings resource of URL path map - [SubResource object](#SubResource) | -| pathRules | array | No | Path rule of URL path map resource - [ApplicationGatewayPathRule object](#ApplicationGatewayPathRule) | -| provisioningState | string | No | Provisioning state of the backend http settings resource Updating/Deleting/Failed | - - - -### ApplicationGatewayRequestRoutingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleType | enum | No | Rule type. - Basic or PathBasedRouting | -| backendAddressPool | object | No | Backend address pool resource of application gateway - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Frontend port resource of application gateway - [SubResource object](#SubResource) | -| httpListener | object | No | Http listener resource of application gateway - [SubResource object](#SubResource) | -| urlPathMap | object | No | Url path map resource of application gateway - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the request routing rule resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Dns name | -| ipAddress | string | No | Ip address | - - - -### ApplicationGatewayPathRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayPathRulePropertiesFormat object](#ApplicationGatewayPathRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method. - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### ApplicationGatewayPathRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| paths | array | No | Path rules of URL path map - string | -| backendAddressPool | object | No | Backend address pool resource of URL path map - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Backend http settings resource of URL path map - [SubResource object](#SubResource) | -| provisioningState | string | No | Path rule of URL path map resource Updating/Deleting/Failed | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| protocol | enum | No | Gets or sets the transport protocol for the endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | 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 | -| backendPort | integer | No | 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 | -| idleTimeoutInMinutes | integer | No | 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 | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets array of references to the external resources using subnet - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | Gets provisioning state of the resource | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or default security rules of network security group - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/connections.md b/test/Resource/Expected/Network/2016-06-01/connections.md deleted file mode 100644 index 8e9a433..0000000 --- a/test/Resource/Expected/Network/2016-06-01/connections.md +++ /dev/null @@ -1,383 +0,0 @@ -# Microsoft.Network/connections template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/connections", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "authorizationKey": "string", - "virtualNetworkGateway1": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "virtualNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "localNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "connectionType": "string", - "routingWeight": "integer", - "sharedKey": "string", - "connectionStatus": "string", - "egressBytesTransferred": "integer", - "ingressBytesTransferred": "integer", - "peer": { - "id": "string" - }, - "enableBgp": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/connections | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualNetworkGatewayConnectionPropertiesFormat object](#VirtualNetworkGatewayConnectionPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### VirtualNetworkGatewayConnectionPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorizationKey. | -| virtualNetworkGateway1 | object | No | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| virtualNetworkGateway2 | object | No | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| localNetworkGateway2 | object | No | [LocalNetworkGateway object](#LocalNetworkGateway) | -| connectionType | enum | No | Gateway connection type -Ipsec/Dedicated/VpnClient/Vnet2Vnet. - IPsec, Vnet2Vnet, ExpressRoute, VPNClient | -| routingWeight | integer | No | The Routing weight. | -| sharedKey | string | No | The Ipsec share key. | -| connectionStatus | enum | No | Virtual network Gateway connection status. - Unknown, Connecting, Connected, NotConnected | -| egressBytesTransferred | integer | No | The Egress Bytes Transferred in this connection | -| ingressBytesTransferred | integer | No | The Ingress Bytes Transferred in this connection | -| peer | object | No | The reference to peerings resource. - [SubResource object](#SubResource) | -| enableBgp | boolean | No | EnableBgp Flag | -| resourceGuid | string | No | Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource | -| provisioningState | string | No | Gets provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed | - - - -### VirtualNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### LocalNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IpConfigurations for Virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. - PolicyBased or RouteBased | -| enableBgp | boolean | No | EnableBgp Flag | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | Gets or sets resource guid property of the VirtualNetworkGateway resource | -| provisioningState | string | No | Gets provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site Address space - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | Gets or sets resource guid property of the LocalNetworkGateway resource | -| provisioningState | string | No | Gets provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway sku name -Basic/HighPerformance/Standard/UltraPerformance. - Basic, HighPerformance, Standard, UltraPerformance | -| tier | enum | No | Gateway sku tier -Basic/HighPerformance/Standard/UltraPerformance. - Basic, HighPerformance, Standard, UltraPerformance | -| capacity | integer | No | The capacity | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for Virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | Gets or sets this BGP speaker's ASN | -| bgpPeeringAddress | string | No | Gets or sets the BGP peering address and BGP identifier of this BGP speaker | -| peerWeight | integer | No | Gets or sets the weight added to routes learned from this BGP speaker | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | Gets or sets list of address blocks reserved for this virtual network in CIDR notation - string | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method. - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | No | Gets or sets the certificate public data | -| provisioningState | string | No | Gets provisioning state of the VPN client root certificate resource Updating/Deleting/Failed | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | Gets or sets the revoked Vpn client certificate thumbprint | -| provisioningState | string | No | Gets provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/expressRouteCircuits.md b/test/Resource/Expected/Network/2016-06-01/expressRouteCircuits.md deleted file mode 100644 index a070dbd..0000000 --- a/test/Resource/Expected/Network/2016-06-01/expressRouteCircuits.md +++ /dev/null @@ -1,208 +0,0 @@ -# Microsoft.Network/expressRouteCircuits template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "family": "string" - }, - "properties": { - "allowClassicOperations": "boolean", - "circuitProvisioningState": "string", - "serviceProviderProvisioningState": "string", - "authorizations": [ - { - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string" - }, - "name": "string", - "etag": "string" - } - ], - "serviceKey": "string", - "serviceProviderNotes": "string", - "serviceProviderProperties": { - "serviceProviderName": "string", - "peeringLocation": "string", - "bandwidthInMbps": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | Gets or sets sku - [ExpressRouteCircuitSku object](#ExpressRouteCircuitSku) | -| properties | object | Yes | [ExpressRouteCircuitPropertiesFormat object](#ExpressRouteCircuitPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | -| resources | array | No | [peerings](./expressRouteCircuits/peerings.md) [authorizations](./expressRouteCircuits/authorizations.md) | - - - -### ExpressRouteCircuitSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Gets or sets name of the sku. | -| tier | enum | No | Gets or sets tier of the sku. - Standard or Premium | -| family | enum | No | Gets or sets family of the sku. - UnlimitedData or MeteredData | - - - -### ExpressRouteCircuitPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowClassicOperations | boolean | No | allow classic operations | -| circuitProvisioningState | string | No | Gets or sets CircuitProvisioningState state of the resource | -| serviceProviderProvisioningState | enum | No | Gets or sets ServiceProviderProvisioningState state of the resource. - NotProvisioned, Provisioning, Provisioned, Deprovisioning | -| authorizations | array | No | Gets or sets list of authorizations - [ExpressRouteCircuitAuthorization object](#ExpressRouteCircuitAuthorization) | -| peerings | array | No | Gets or sets list of peerings - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | -| serviceKey | string | No | Gets or sets ServiceKey | -| serviceProviderNotes | string | No | Gets or sets ServiceProviderNotes | -| serviceProviderProperties | object | No | Gets or sets ServiceProviderProperties - [ExpressRouteCircuitServiceProviderProperties object](#ExpressRouteCircuitServiceProviderProperties) | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | -| gatewayManagerEtag | string | No | Gets or sets the GatewayManager Etag | - - - -### ExpressRouteCircuitAuthorization object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ExpressRouteCircuitServiceProviderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceProviderName | string | No | Gets or sets serviceProviderName. | -| peeringLocation | string | No | Gets or sets peering location. | -| bandwidthInMbps | integer | No | Gets or sets BandwidthInMbps. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | Gets or sets the authorization key | -| authorizationUseStatus | enum | No | Gets or sets AuthorizationUseStatus. - Available or InUse | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | Gets or sets PeeringType. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | Gets or sets state of Peering. - Disabled or Enabled | -| azureASN | integer | No | Gets or sets the azure ASN | -| peerASN | integer | No | Gets or sets the peer ASN | -| primaryPeerAddressPrefix | string | No | Gets or sets the primary address prefix | -| secondaryPeerAddressPrefix | string | No | Gets or sets the secondary address prefix | -| primaryAzurePort | string | No | Gets or sets the primary port | -| secondaryAzurePort | string | No | Gets or sets the secondary port | -| sharedKey | string | No | Gets or sets the shared key | -| vlanId | integer | No | Gets or sets the vlan id | -| microsoftPeeringConfig | object | No | Gets or sets the mircosoft peering config - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets or peering stats - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | -| gatewayManagerEtag | string | No | Gets or sets the GatewayManager Etag | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | Gets or sets the reference of AdvertisedPublicPrefixes - string | -| advertisedPublicPrefixesState | enum | No | Gets or sets AdvertisedPublicPrefixState of the Peering resource. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | Gets or Sets CustomerAsn of the peering. | -| routingRegistryName | string | No | Gets or Sets RoutingRegistryName of the config. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - diff --git a/test/Resource/Expected/Network/2016-06-01/expressRouteCircuits/authorizations.md b/test/Resource/Expected/Network/2016-06-01/expressRouteCircuits/authorizations.md deleted file mode 100644 index 916dbeb..0000000 --- a/test/Resource/Expected/Network/2016-06-01/expressRouteCircuits/authorizations.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/authorizations template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/authorizations", - "apiVersion": "2016-06-01", - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/authorizations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/authorizations | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| properties | object | Yes | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | Gets or sets the authorization key | -| authorizationUseStatus | enum | No | Gets or sets AuthorizationUseStatus. - Available or InUse | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/expressRouteCircuits/peerings.md b/test/Resource/Expected/Network/2016-06-01/expressRouteCircuits/peerings.md deleted file mode 100644 index f6ef7e4..0000000 --- a/test/Resource/Expected/Network/2016-06-01/expressRouteCircuits/peerings.md +++ /dev/null @@ -1,100 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/peerings template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/peerings", - "apiVersion": "2016-06-01", - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/peerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/peerings | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| properties | object | Yes | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | Gets or sets PeeringType. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | Gets or sets state of Peering. - Disabled or Enabled | -| azureASN | integer | No | Gets or sets the azure ASN | -| peerASN | integer | No | Gets or sets the peer ASN | -| primaryPeerAddressPrefix | string | No | Gets or sets the primary address prefix | -| secondaryPeerAddressPrefix | string | No | Gets or sets the secondary address prefix | -| primaryAzurePort | string | No | Gets or sets the primary port | -| secondaryAzurePort | string | No | Gets or sets the secondary port | -| sharedKey | string | No | Gets or sets the shared key | -| vlanId | integer | No | Gets or sets the vlan id | -| microsoftPeeringConfig | object | No | Gets or sets the mircosoft peering config - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets or peering stats - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | -| gatewayManagerEtag | string | No | Gets or sets the GatewayManager Etag | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | Gets or sets the reference of AdvertisedPublicPrefixes - string | -| advertisedPublicPrefixesState | enum | No | Gets or sets AdvertisedPublicPrefixState of the Peering resource. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | Gets or Sets CustomerAsn of the peering. | -| routingRegistryName | string | No | Gets or Sets RoutingRegistryName of the config. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - diff --git a/test/Resource/Expected/Network/2016-06-01/loadBalancers.md b/test/Resource/Expected/Network/2016-06-01/loadBalancers.md deleted file mode 100644 index 37ddd1f..0000000 --- a/test/Resource/Expected/Network/2016-06-01/loadBalancers.md +++ /dev/null @@ -1,592 +0,0 @@ -# Microsoft.Network/loadBalancers template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/loadBalancers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendAddressPool": { - "id": "string" - }, - "probe": { - "id": "string" - }, - "protocol": "string", - "loadDistribution": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "port": "integer", - "intervalInSeconds": "integer", - "numberOfProbes": "integer", - "requestPath": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatPools": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "backendPort": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "outboundNatRules": [ - { - "id": "string", - "properties": { - "allocatedOutboundPorts": "integer", - "frontendIPConfigurations": [ - { - "id": "string" - } - ], - "backendAddressPool": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [LoadBalancerPropertiesFormat object](#LoadBalancerPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### LoadBalancerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfigurations | array | No | Gets or sets frontend IP addresses of the load balancer - [FrontendIPConfiguration object](#FrontendIPConfiguration) | -| backendAddressPools | array | No | Gets or sets Pools of backend IP addresses - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancingRules | array | No | Gets or sets load balancing rules - [LoadBalancingRule object](#LoadBalancingRule) | -| probes | array | No | Gets or sets list of Load balancer probes - [Probe object](#Probe) | -| inboundNatRules | array | No | Gets or sets list of inbound rules - [InboundNatRule object](#InboundNatRule) | -| inboundNatPools | array | No | Gets or sets inbound NAT pools - [InboundNatPool object](#InboundNatPool) | -| outboundNatRules | array | No | Gets or sets outbound NAT rules - [OutboundNatRule object](#OutboundNatRule) | -| resourceGuid | string | No | Gets or sets resource guid property of the Load balancer resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### FrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [FrontendIPConfigurationPropertiesFormat object](#FrontendIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### LoadBalancingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [LoadBalancingRulePropertiesFormat object](#LoadBalancingRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Probe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ProbePropertiesFormat object](#ProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatPoolPropertiesFormat object](#InboundNatPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### OutboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [OutboundNatRulePropertiesFormat object](#OutboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### FrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | Gets or sets the privateIPAddress of the IP Configuration | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method. - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [Subnet object](#Subnet) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### LoadBalancingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| backendAddressPool | object | No | Gets or sets a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs - [SubResource object](#SubResource) | -| probe | object | No | Gets or sets the reference of the load balancer probe used by the Load Balancing rule. - [SubResource object](#SubResource) | -| protocol | enum | Yes | Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| loadDistribution | enum | No | Gets or sets the load distribution policy for this rule. - Default, SourceIP, SourceIPProtocol | -| frontendPort | integer | Yes | 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 | -| backendPort | integer | No | 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 | -| idleTimeoutInMinutes | integer | No | 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 | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | Yes | 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. - Http or Tcp | -| port | integer | Yes | Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive. | -| intervalInSeconds | integer | No | 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 | -| numberOfProbes | integer | No | 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. | -| requestPath | string | No | 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 | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| protocol | enum | No | Gets or sets the transport protocol for the endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | 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 | -| backendPort | integer | No | 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 | -| idleTimeoutInMinutes | integer | No | 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 | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| protocol | enum | Yes | Gets or sets the transport protocol for the endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPortRangeStart | integer | Yes | 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 | -| frontendPortRangeEnd | integer | Yes | 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 | -| backendPort | integer | Yes | 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 | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### OutboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allocatedOutboundPorts | integer | No | Gets or sets the number of outbound ports to be used for SNAT | -| frontendIPConfigurations | array | No | Gets or sets Frontend IP addresses of the load balancer - [SubResource object](#SubResource) | -| backendAddressPool | object | Yes | Gets or sets a reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets array of references to the external resources using subnet - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | Gets provisioning state of the resource | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or default security rules of network security group - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/localNetworkGateways.md b/test/Resource/Expected/Network/2016-06-01/localNetworkGateways.md deleted file mode 100644 index 79e3ea5..0000000 --- a/test/Resource/Expected/Network/2016-06-01/localNetworkGateways.md +++ /dev/null @@ -1,76 +0,0 @@ -# Microsoft.Network/localNetworkGateways template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/localNetworkGateways", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/localNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/localNetworkGateways | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site Address space - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | Gets or sets resource guid property of the LocalNetworkGateway resource | -| provisioningState | string | No | Gets provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | Gets or sets list of address blocks reserved for this virtual network in CIDR notation - string | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | Gets or sets this BGP speaker's ASN | -| bgpPeeringAddress | string | No | Gets or sets the BGP peering address and BGP identifier of this BGP speaker | -| peerWeight | integer | No | Gets or sets the weight added to routes learned from this BGP speaker | - diff --git a/test/Resource/Expected/Network/2016-06-01/networkInterfaces.md b/test/Resource/Expected/Network/2016-06-01/networkInterfaces.md deleted file mode 100644 index d85a91e..0000000 --- a/test/Resource/Expected/Network/2016-06-01/networkInterfaces.md +++ /dev/null @@ -1,555 +0,0 @@ -# Microsoft.Network/networkInterfaces template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/networkInterfaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkInterfaces", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkInterfaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkInterfaces | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | Gets or sets the reference of a VirtualMachine - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | Gets or sets list of IPConfigurations of the network interface - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | Gets or sets DNS settings in network interface - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | Gets the MAC address of the network interface | -| primary | boolean | No | Gets whether this is a primary NIC on a virtual machine | -| enableIPForwarding | boolean | No | Gets or sets whether IPForwarding is enabled on the NIC | -| resourceGuid | string | No | Gets or sets resource guid property of the network interface resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | -| appliedDnsServers | array | No | Gets or sets list of Applied DNS servers IP addresses - string | -| internalDnsNameLabel | string | No | Gets or sets the internal DNS name | -| internalFqdn | string | No | Gets or sets the internal fqdn. | -| internalDomainNameSuffix | string | No | Gets or sets internal domain name suffix of the NIC. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or default security rules of network security group - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | Gets or sets the reference of ApplicationGatewayBackendAddressPool resource - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | Gets or sets the reference of LoadBalancerBackendAddressPool resource - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | Gets or sets list of references of LoadBalancerInboundNatRules - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method. - Static or Dynamic | -| privateIPAddressVersion | enum | No | Gets or sets PrivateIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the NIC | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in NICs - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource Updating/Deleting/Failed | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Gets or sets a reference to frontend IP Addresses - [SubResource object](#SubResource) | -| protocol | enum | No | Gets or sets the transport protocol for the endpoint. Possible values are Udp or Tcp. - Udp or Tcp | -| frontendPort | integer | No | 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 | -| backendPort | integer | No | 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 | -| idleTimeoutInMinutes | integer | No | 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 | -| enableFloatingIP | boolean | No | Configures a virtual 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 | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets array of references to the external resources using subnet - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | Gets provisioning state of the resource | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Dns name | -| ipAddress | string | No | Ip address | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource | -| link | string | No | Link to the external resource | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/networkSecurityGroups.md b/test/Resource/Expected/Network/2016-06-01/networkSecurityGroups.md deleted file mode 100644 index 86e5ff5..0000000 --- a/test/Resource/Expected/Network/2016-06-01/networkSecurityGroups.md +++ /dev/null @@ -1,114 +0,0 @@ -# Microsoft.Network/networkSecurityGroups template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | -| resources | array | No | [securityRules](./networkSecurityGroups/securityRules.md) | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or default security rules of network security group - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/networkSecurityGroups/securityRules.md b/test/Resource/Expected/Network/2016-06-01/networkSecurityGroups/securityRules.md deleted file mode 100644 index e134e6e..0000000 --- a/test/Resource/Expected/Network/2016-06-01/networkSecurityGroups/securityRules.md +++ /dev/null @@ -1,58 +0,0 @@ -# Microsoft.Network/networkSecurityGroups/securityRules template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups/securityRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups/securityRules", - "apiVersion": "2016-06-01", - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups/securityRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups/securityRules | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| properties | object | Yes | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/publicIPAddresses.md b/test/Resource/Expected/Network/2016-06-01/publicIPAddresses.md deleted file mode 100644 index b9d462d..0000000 --- a/test/Resource/Expected/Network/2016-06-01/publicIPAddresses.md +++ /dev/null @@ -1,69 +0,0 @@ -# Microsoft.Network/publicIPAddresses template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/publicIPAddresses", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/publicIPAddresses object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/publicIPAddresses | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | Gets or sets PublicIP allocation method (Static/Dynamic). - Static or Dynamic | -| publicIPAddressVersion | enum | No | Gets or sets PublicIP address version (IPv4/IPv6). - IPv4 or IPv6 | -| dnsSettings | object | No | Gets or sets FQDN of the DNS record associated with the public IP address - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | Gets or sets the Idletimeout of the public IP address | -| resourceGuid | string | No | Gets or sets resource guid property of the PublicIP resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - diff --git a/test/Resource/Expected/Network/2016-06-01/routeTables.md b/test/Resource/Expected/Network/2016-06-01/routeTables.md deleted file mode 100644 index 25be4fc..0000000 --- a/test/Resource/Expected/Network/2016-06-01/routeTables.md +++ /dev/null @@ -1,80 +0,0 @@ -# Microsoft.Network/routeTables template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/routeTables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | -| resources | array | No | [routes](./routeTables/routes.md) | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/routeTables/routes.md b/test/Resource/Expected/Network/2016-06-01/routeTables/routes.md deleted file mode 100644 index b5b0ca3..0000000 --- a/test/Resource/Expected/Network/2016-06-01/routeTables/routes.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Network/routeTables/routes template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/routeTables/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables/routes", - "apiVersion": "2016-06-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables/routes | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| properties | object | Yes | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/virtualNetworkGateways.md b/test/Resource/Expected/Network/2016-06-01/virtualNetworkGateways.md deleted file mode 100644 index dca3324..0000000 --- a/test/Resource/Expected/Network/2016-06-01/virtualNetworkGateways.md +++ /dev/null @@ -1,215 +0,0 @@ -# Microsoft.Network/virtualNetworkGateways template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/virtualNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworkGateways", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworkGateways | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IpConfigurations for Virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. - PolicyBased or RouteBased | -| enableBgp | boolean | No | EnableBgp Flag | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | Gets or sets resource guid property of the VirtualNetworkGateway resource | -| provisioningState | string | No | Gets provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway sku name -Basic/HighPerformance/Standard/UltraPerformance. - Basic, HighPerformance, Standard, UltraPerformance | -| tier | enum | No | Gateway sku tier -Basic/HighPerformance/Standard/UltraPerformance. - Basic, HighPerformance, Standard, UltraPerformance | -| capacity | integer | No | The capacity | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for Virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | Gets or sets this BGP speaker's ASN | -| bgpPeeringAddress | string | No | Gets or sets the BGP peering address and BGP identifier of this BGP speaker | -| peerWeight | integer | No | Gets or sets the weight added to routes learned from this BGP speaker | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | Gets or sets PrivateIP allocation method. - Static or Dynamic | -| subnet | object | No | Gets or sets the reference of the subnet resource - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Gets or sets the reference of the PublicIP resource - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | Gets or sets list of address blocks reserved for this virtual network in CIDR notation - string | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | No | Gets or sets the certificate public data | -| provisioningState | string | No | Gets provisioning state of the VPN client root certificate resource Updating/Deleting/Failed | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | Gets or sets the revoked Vpn client certificate thumbprint | -| provisioningState | string | No | Gets provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/virtualNetworks.md b/test/Resource/Expected/Network/2016-06-01/virtualNetworks.md deleted file mode 100644 index 190861a..0000000 --- a/test/Resource/Expected/Network/2016-06-01/virtualNetworks.md +++ /dev/null @@ -1,339 +0,0 @@ -# Microsoft.Network/virtualNetworks template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/virtualNetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks", - "apiVersion": "2016-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "addressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "string" - ] - }, - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "VirtualNetworkPeerings": [ - { - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [VirtualNetworkPropertiesFormat object](#VirtualNetworkPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | -| resources | array | No | [virtualNetworkPeerings](./virtualNetworks/virtualNetworkPeerings.md) [subnets](./virtualNetworks/subnets.md) | - - - -### VirtualNetworkPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressSpace | object | No | Gets or sets AddressSpace that contains an array of IP address ranges that can be used by subnets - [AddressSpace object](#AddressSpace) | -| dhcpOptions | object | No | Gets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtual network - [DhcpOptions object](#DhcpOptions) | -| subnets | array | No | Gets or sets list of subnets in a VirtualNetwork - [Subnet object](#Subnet) | -| VirtualNetworkPeerings | array | No | Gets or sets list of peerings in a VirtualNetwork - [VirtualNetworkPeering object](#VirtualNetworkPeering) | -| resourceGuid | string | No | Gets or sets resource guid property of the VirtualNetwork resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | Gets or sets list of address blocks reserved for this virtual network in CIDR notation - string | - - - -### DhcpOptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | Gets or sets list of DNS servers IP addresses - string | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VirtualNetworkPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| name | string | No | Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets array of references to the external resources using subnet - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | Gets provisioning state of the resource | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | 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 | -| allowForwardedTraffic | boolean | No | Gets or sets whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed | -| allowGatewayTransit | boolean | No | Gets or sets if gatewayLinks can be used in remote virtual network’s link to this virtual network | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | Gets or sets the reference of the remote virtual network - [SubResource object](#SubResource) | -| peeringState | enum | No | Gets the status of the virtual network peering. - Initiated, Connected, Disconnected | -| provisioningState | string | No | Gets provisioning state of the resource | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or default security rules of network security group - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/virtualNetworks/subnets.md b/test/Resource/Expected/Network/2016-06-01/virtualNetworks/subnets.md deleted file mode 100644 index 263717f..0000000 --- a/test/Resource/Expected/Network/2016-06-01/virtualNetworks/subnets.md +++ /dev/null @@ -1,228 +0,0 @@ -# Microsoft.Network/virtualNetworks/subnets template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/subnets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/subnets", - "apiVersion": "2016-06-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/subnets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/subnets | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| properties | object | Yes | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets Address prefix for the subnet. | -| networkSecurityGroup | object | No | Gets or sets the reference of the NetworkSecurityGroup resource - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | Gets or sets the reference of the RouteTable resource - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets array of references to the external resources using subnet - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | Gets provisioning state of the resource | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| location | string | No | Resource location | -| tags | object | No | Resource tags | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | Gets or sets security rules of network security group - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | Gets or default security rules of network security group - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | Gets or sets resource guid property of the network security group resource | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Gets or sets Routes in a Route Table - [Route object](#Route) | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | Gets or sets a description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). - Tcp, Udp, * | -| sourcePortRange | string | No | Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic. - Inbound or Outbound | -| provisioningState | string | No | Gets provisioning state of the PublicIP resource Updating/Deleting/Failed | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | Gets or sets the destination CIDR to which the route applies. | -| nextHopType | enum | Yes | Gets or sets the type of Azure hop the packet should be sent to. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | 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. | -| provisioningState | string | No | Gets provisioning state of the resource Updating/Deleting/Failed | - diff --git a/test/Resource/Expected/Network/2016-06-01/virtualNetworks/virtualNetworkPeerings.md b/test/Resource/Expected/Network/2016-06-01/virtualNetworks/virtualNetworkPeerings.md deleted file mode 100644 index 22c2ce8..0000000 --- a/test/Resource/Expected/Network/2016-06-01/virtualNetworks/virtualNetworkPeerings.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/virtualNetworks/virtualNetworkPeerings template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/virtualNetworkPeerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings", - "apiVersion": "2016-06-01", - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/virtualNetworkPeerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/virtualNetworkPeerings | -| apiVersion | enum | Yes | 2016-06-01 | -| id | string | No | Resource Id | -| properties | object | Yes | [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | 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 | -| allowForwardedTraffic | boolean | No | Gets or sets whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed | -| allowGatewayTransit | boolean | No | Gets or sets if gatewayLinks can be used in remote virtual network’s link to this virtual network | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | Gets or sets the reference of the remote virtual network - [SubResource object](#SubResource) | -| peeringState | enum | No | Gets the status of the virtual network peering. - Initiated, Connected, Disconnected | -| provisioningState | string | No | Gets provisioning state of the resource | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource Id | - diff --git a/test/Resource/Expected/Network/2016-09-01/Microsoft.Network.json b/test/Resource/Expected/Network/2016-09-01/Microsoft.Network.json deleted file mode 100644 index 7e66056..0000000 --- a/test/Resource/Expected/Network/2016-09-01/Microsoft.Network.json +++ /dev/null @@ -1,5773 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-09-01/Microsoft.Network.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Network", - "description": "Microsoft Network Resource Types", - "resourceDefinitions": { - "applicationGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationGateways" - }, - "connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/connections" - }, - "expressRouteCircuits": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/expressRouteCircuits_authorizations_childResource" - }, - { - "$ref": "#/definitions/expressRouteCircuits_peerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits" - }, - "expressRouteCircuits_authorizations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "loadBalancers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers" - }, - "localNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/localNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/localNetworkGateways" - }, - "networkInterfaces": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkInterfaces" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkInterfaces" - }, - "networkSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkSecurityGroups_securityRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups" - }, - "networkSecurityGroups_securityRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups/securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "networkWatchers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkWatcherPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkWatchers_packetCaptures_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers" - }, - "networkWatchers_packetCaptures": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers/packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "publicIPAddresses": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/publicIPAddresses" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/publicIPAddresses" - }, - "routeTables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeTables_routes_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables" - }, - "routeTables_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "virtualNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworkGateways" - }, - "virtualNetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualNetworks_subnets_childResource" - }, - { - "$ref": "#/definitions/virtualNetworks_virtualNetworkPeerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks" - }, - "virtualNetworks_subnets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - } - }, - "definitions": { - "AddressSpace": { - "type": "object", - "properties": { - "addressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of address blocks reserved for this virtual network in CIDR notation." - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." - }, - "ApplicationGatewayAuthenticationCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Authentication certificates of an application gateway." - }, - "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Certificate public data." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Authentication certificates properties of an application gateway." - }, - "ApplicationGatewayBackendAddress": { - "type": "object", - "properties": { - "fqdn": { - "type": "string", - "description": "Fully qualified domain name (FQDN)." - }, - "ipAddress": { - "type": "string", - "description": "IP address" - } - }, - "description": "Backend address of an application gateway." - }, - "ApplicationGatewayBackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of references to IPs defined in network interfaces." - }, - "backendAddresses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddress" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend addresses" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendHttpSettings": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Backend address pool settings of an application gateway." - }, - "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Port" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol. Possible values are: 'Http' and 'Https'." - }, - "cookieBasedAffinity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'." - }, - "requestTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probe resource of an application gateway." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of references to application gateway authentication certificates." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend address pool settings of an application gateway." - }, - "ApplicationGatewayFrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "PrivateIPAddress of the network interface IP Configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the PublicIP resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendPort": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Frontend port of an application gateway." - }, - "ApplicationGatewayFrontendPortPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend port of an application gateway." - }, - "ApplicationGatewayHttpListener": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Http listener of an application gateway." - }, - "ApplicationGatewayHttpListenerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP configuration resource of an application gateway." - }, - "frontendPort": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of an application gateway." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol. Possible values are: 'Http' and 'Https'." - }, - "hostName": { - "type": "string", - "description": "Host name of HTTP listener." - }, - "sslCertificate": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificate resource of an application gateway." - }, - "requireServerNameIndication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of HTTP listener of an application gateway." - }, - "ApplicationGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." - }, - "ApplicationGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration of an application gateway." - }, - "ApplicationGatewayPathRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Path rule of URL path map of an application gateway." - }, - "ApplicationGatewayPathRulePropertiesFormat": { - "type": "object", - "properties": { - "paths": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules of URL path map." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of URL path map." - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings resource of URL path map." - }, - "provisioningState": { - "type": "string", - "description": "Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayProbe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Probe of the application gateway." - }, - "ApplicationGatewayProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol. Possible values are: 'Http' and 'Https'." - }, - "host": { - "type": "string", - "description": "Host name to send the probe to." - }, - "path": { - "type": "string", - "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:" - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." - }, - "timeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayPropertiesFormat": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU of the application gateway resource." - }, - "sslPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL policy of the application gateway resource." - }, - "gatewayIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnets of application the gateway resource." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Authentication certificates of the application gateway resource." - }, - "sslCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewaySslCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificates of the application gateway resource." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP addresses of the application gateway resource." - }, - "frontendPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendPort" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend ports of the application gateway resource." - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayProbe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probes of the application gateway resource." - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool of the application gateway resource." - }, - "backendHttpSettingsCollection": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings of the application gateway resource." - }, - "httpListeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayHttpListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listeners of the application gateway resource." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayUrlPathMap" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map of the application gateway resource." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing rules of the application gateway resource." - }, - "webApplicationFirewallConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall configuration." - }, - "resourceGuid": { - "type": "string", - "description": "Resource GUID property of the application gateway resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the application gateway." - }, - "ApplicationGatewayRequestRoutingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Request routing rule of an application gateway." - }, - "ApplicationGatewayRequestRoutingRulePropertiesFormat": { - "type": "object", - "properties": { - "ruleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "PathBasedRouting" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Rule type. Possible values are: 'Basic' and 'PathBasedRouting'." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of the application gateway. " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of the application gateway." - }, - "httpListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listener resource of the application gateway. " - }, - "urlPathMap": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map resource of the application gateway." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of request routing rule of the application gateway." - }, - "ApplicationGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_Small", - "Standard_Medium", - "Standard_Large", - "WAF_Medium", - "WAF_Large" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "WAF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tier of an application gateway. Possible values are: 'Standard' and 'WAF'." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity (instance count) of an application gateway." - } - }, - "description": "SKU of an application gateway" - }, - "ApplicationGatewaySslCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "SSL certificates of an application gateway." - }, - "ApplicationGatewaySslCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." - }, - "password": { - "type": "string", - "description": "Password for the pfx file specified in data. Only applicable in PUT request." - }, - "publicCertData": { - "type": "string", - "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of SSL certificates of an application gateway." - }, - "ApplicationGatewaySslPolicy": { - "type": "object", - "properties": { - "disabledSslProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL protocols to be disabled on application gateway. Possible values are: 'TLSv1_0', 'TLSv1_1', and 'TLSv1_2'." - } - }, - "description": "Application gateway SSL policy." - }, - "ApplicationGatewayUrlPathMap": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." - }, - "ApplicationGatewayUrlPathMapPropertiesFormat": { - "type": "object", - "properties": { - "defaultBackendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend address pool resource of URL path map." - }, - "defaultBackendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend http settings resource of URL path map." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayPathRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rule of URL path map resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of UrlPathMap of the application gateway." - }, - "ApplicationGatewayWebApplicationFirewallConfiguration": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the web application firewall is enabled." - }, - "firewallMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Detection", - "Prevention" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall mode. Possible values are: 'Detection' and 'Prevention'." - } - }, - "required": [ - "enabled" - ], - "description": "Application gateway web application firewall configuration." - }, - "AuthorizationPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorization key." - }, - "authorizationUseStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Available", - "InUse" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "BackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Pool of backend IP addresses." - }, - "BackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "description": "Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the backend address pool." - }, - "BgpSettings": { - "type": "object", - "properties": { - "asn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BGP speaker's ASN." - }, - "bgpPeeringAddress": { - "type": "string", - "description": "The BGP peering address and BGP identifier of this BGP speaker." - }, - "peerWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The weight added to routes learned from this BGP speaker." - } - } - }, - "DhcpOptions": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of DNS servers IP addresses." - } - }, - "description": "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." - }, - "ExpressRouteCircuitAuthorization": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Authorization in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Peering in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "advertisedPublicPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of AdvertisedPublicPrefixes." - }, - "advertisedPublicPrefixesState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotConfigured", - "Configuring", - "Configured", - "ValidationNeeded" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'." - }, - "customerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CustomerASN of the peering." - }, - "routingRegistryName": { - "type": "string", - "description": "The RoutingRegistryName of the configuration." - } - }, - "description": "Specifies the peering configuration." - }, - "ExpressRouteCircuitPeeringPropertiesFormat": { - "type": "object", - "properties": { - "peeringType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzurePublicPeering", - "AzurePrivatePeering", - "MicrosoftPeering" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - }, - "azureASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Azure ASN." - }, - "peerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The peer ASN." - }, - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "primaryAzurePort": { - "type": "string", - "description": "The primary port." - }, - "secondaryAzurePort": { - "type": "string", - "description": "The secondary port." - }, - "sharedKey": { - "type": "string", - "description": "The shared key." - }, - "vlanId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The VLAN ID." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "stats": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitStats" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets peering stats." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets whether the provider or the customer last modified the peering." - } - } - }, - "ExpressRouteCircuitPropertiesFormat": { - "type": "object", - "properties": { - "allowClassicOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allow classic operations" - }, - "circuitProvisioningState": { - "type": "string", - "description": "The CircuitProvisioningState state of the resource." - }, - "serviceProviderProvisioningState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotProvisioned", - "Provisioning", - "Provisioned", - "Deprovisioning" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'." - }, - "authorizations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitAuthorization" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of authorizations." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of peerings." - }, - "serviceKey": { - "type": "string", - "description": "The ServiceKey." - }, - "serviceProviderNotes": { - "type": "string", - "description": "The ServiceProviderNotes." - }, - "serviceProviderProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProperties." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - } - }, - "description": "Properties of ExpressRouteCircuit." - }, - "ExpressRouteCircuitServiceProviderProperties": { - "type": "object", - "properties": { - "serviceProviderName": { - "type": "string", - "description": "The serviceProviderName." - }, - "peeringLocation": { - "type": "string", - "description": "The peering location." - }, - "bandwidthInMbps": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BandwidthInMbps." - } - }, - "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tier of the SKU. Possible values are 'Standard' and 'Premium'." - }, - "family": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UnlimitedData", - "MeteredData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'." - } - }, - "description": "Contains SKU in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitStats": { - "type": "object", - "properties": { - "primarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "primarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - }, - "secondarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "secondarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - } - }, - "description": "Contains stats associated with the peering." - }, - "expressRouteCircuits_authorizations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "FrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Frontend IP address of the load balancer." - }, - "FrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "The private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the Public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP Configuration of the load balancer." - }, - "InboundNatPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT pool of the load balancer." - }, - "InboundNatPoolPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPortRangeStart", - "frontendPortRangeEnd", - "backendPort" - ], - "description": "Properties of Inbound NAT pool." - }, - "InboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT rule of the load balancer." - }, - "InboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the inbound NAT rule." - }, - "LoadBalancerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/FrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object representing the frontend IPs to be used for the load balancer" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of backend address pools used by a load balancer" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object collection representing the load balancing rules Gets the provisioning " - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Probe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of probe objects used in the load balancer" - }, - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/OutboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The outbound NAT rules." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the load balancer resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the load balancer." - }, - "LoadBalancingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A loag balancing rule for a load balancer." - }, - "LoadBalancingRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the load balancer probe used by the load balancing rule." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'." - }, - "loadDistribution": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "SourceIP", - "SourceIPProtocol" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. " - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPort" - ], - "description": "Properties of the load balancer." - }, - "LocalNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "LocalNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "localNetworkAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network site address space." - }, - "gatewayIpAddress": { - "type": "string", - "description": "IP address of local network gateway." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the LocalNetworkGateway resource." - } - }, - "required": [ - "localNetworkAddressSpace" - ], - "description": "LocalNetworkGateway properties" - }, - "NetworkInterfaceDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "appliedDnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "internalDnsNameLabel": { - "type": "string", - "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." - }, - "internalFqdn": { - "type": "string", - "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." - }, - "internalDomainNameSuffix": { - "type": "string", - "description": "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." - } - }, - "description": "DNS settings of a network interface." - }, - "NetworkInterfaceIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IPConfiguration in a network interface." - }, - "NetworkInterfaceIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of ApplicationGatewayBackendAddressPool resource." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of LoadBalancerBackendAddressPool resource." - }, - "loadBalancerInboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references of LoadBalancerInboundNatRules." - }, - "privateIPAddress": { - "type": "string" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary customer address on the network interface." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "provisioningState": { - "type": "string" - } - }, - "description": "Properties of IP configuration." - }, - "NetworkInterfacePropertiesFormat": { - "type": "object", - "properties": { - "virtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of a virtual machine." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of IPConfigurations of the network interface." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DNS settings in network interface." - }, - "macAddress": { - "type": "string", - "description": "The MAC address of the network interface." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary network interface on a virtual machine." - }, - "enableAcceleratedNetworking": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the network interface is accelerated networking enabled." - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether IP forwarding is enabled on this network interface." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network interface resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "NetworkInterface properties. " - }, - "NetworkSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "NetworkSecurityGroup resource." - }, - "NetworkSecurityGroupPropertiesFormat": { - "type": "object", - "properties": { - "securityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of security rules of the network security group." - }, - "defaultSecurityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The default security rules of network security group." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network security group resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Network Security Group resource." - }, - "networkSecurityGroups_securityRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "NetworkWatcherPropertiesFormat": { - "type": "object", - "properties": {}, - "description": "The network watcher properties." - }, - "networkWatchers_packetCaptures_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "OutboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OutboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Outbound NAT pool of the load balancer." - }, - "OutboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "allocatedOutboundPorts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of outbound ports to be used for NAT." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Frontend IP addresses of the load balancer." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "backendAddressPool" - ], - "description": "Outbound NAT pool of the load balancer." - }, - "PacketCaptureFilter": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TCP", - "UDP", - "Any" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol to be filtered on." - }, - "localIPAddress": { - "type": "string", - "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." - }, - "remoteIPAddress": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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." - }, - "remotePort": { - "type": "string", - "description": "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." - } - }, - "description": "Filter that is applied to packet capture request. Multiple filters can be applied." - }, - "PacketCaptureParameters": { - "type": "object", - "properties": { - "target": { - "type": "string", - "description": "The ID of the targeted resource, only VM is currently supported." - }, - "bytesToCapturePerPacket": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of bytes captured per packet, the remaining bytes are truncated." - }, - "totalBytesPerSession": { - "oneOf": [ - { - "type": "integer", - "default": "1073741824" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum size of the capture output." - }, - "timeLimitInSeconds": { - "oneOf": [ - { - "type": "integer", - "default": "18000" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum duration of the capture session in seconds." - }, - "storageLocation": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureStorageLocation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "filters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PacketCaptureFilter" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "target", - "storageLocation" - ], - "description": "Parameters that define the create packet capture operation." - }, - "PacketCaptureStorageLocation": { - "type": "object", - "properties": { - "storageId": { - "type": "string", - "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." - }, - "storagePath": { - "type": "string", - "description": "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." - }, - "filePath": { - "type": "string", - "description": "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." - } - }, - "description": "Describes the storage location for a packet capture session." - }, - "Probe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancer probe." - }, - "ProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." - }, - "intervalInSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "numberOfProbes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "requestPath": { - "type": "string", - "description": "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." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "port" - ] - }, - "PublicIPAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Public IP address resource." - }, - "PublicIPAddressDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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. " - } - }, - "description": "Contains FQDN of the DNS record associated with the public IP address" - }, - "PublicIPAddressPropertiesFormat": { - "type": "object", - "properties": { - "publicIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "publicIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The FQDN of the DNS record associated with the public IP address." - }, - "ipAddress": { - "type": "string" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The idle timeout of the public IP address." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Public IP address properties." - }, - "ResourceNavigationLink": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceNavigationLinkFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "ResourceNavigationLink resource." - }, - "ResourceNavigationLinkFormat": { - "type": "object", - "properties": { - "linkedResourceType": { - "type": "string", - "description": "Resource type of the linked resource." - }, - "link": { - "type": "string", - "description": "Link to the external resource" - } - }, - "description": "Properties of ResourceNavigationLink." - }, - "Route": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route resource" - }, - "RoutePropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The destination CIDR to which the route applies." - }, - "nextHopType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VirtualNetworkGateway", - "VnetLocal", - "Internet", - "VirtualAppliance", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'." - }, - "nextHopIpAddress": { - "type": "string", - "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "nextHopType" - ], - "description": "Route resource" - }, - "RouteTable": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route table resource." - }, - "RouteTablePropertiesFormat": { - "type": "object", - "properties": { - "routes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Route" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of routes contained within a route table." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Route Table resource" - }, - "routeTables_routes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "SecurityRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Network security rule." - }, - "SecurityRulePropertiesFormat": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description for this rule. Restricted to 140 chars." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp", - "*" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'." - }, - "sourcePortRange": { - "type": "string", - "description": "The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "destinationPortRange": { - "type": "string", - "description": "The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "sourceAddressPrefix": { - "type": "string", - "description": "The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " - }, - "destinationAddressPrefix": { - "type": "string", - "description": "The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'." - }, - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "sourceAddressPrefix", - "destinationAddressPrefix", - "access", - "direction" - ] - }, - "Subnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Subnet in a virtual network resource." - }, - "SubnetPropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The address prefix for the subnet." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "routeTable": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTable" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteTable resource." - }, - "resourceNavigationLinks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceNavigationLink" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets an array of references to the external resources using subnet." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - } - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - } - } - }, - "VirtualNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "VirtualNetworkGatewayConnectionPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorizationKey." - }, - "virtualNetworkGateway1": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "virtualNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "localNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "connectionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPsec", - "Vnet2Vnet", - "ExpressRoute", - "VPNClient" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient." - }, - "routingWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The routing weight." - }, - "sharedKey": { - "type": "string", - "description": "The IPSec shared key." - }, - "peer": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to peerings resource." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp flag" - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." - } - }, - "required": [ - "virtualNetworkGateway1", - "connectionType" - ], - "description": "VirtualNetworkGatewayConnection properties" - }, - "VirtualNetworkGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration for virtual network gateway" - }, - "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the public IP resource." - } - }, - "required": [ - "subnet", - "publicIPAddress" - ], - "description": "Properties of VirtualNetworkGatewayIPConfiguration" - }, - "VirtualNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IP configurations for virtual network gateway." - }, - "gatewayType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Vpn", - "ExpressRoute" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PolicyBased", - "RouteBased" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether BGP is enabled for this virtual network gateway or not." - }, - "activeActive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "ActiveActive flag" - }, - "gatewayDefaultSite": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." - }, - "vpnClientConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGateway resource." - } - }, - "required": [ - "ipConfigurations", - "gatewayType", - "vpnType" - ], - "description": "VirtualNetworkGateway properties" - }, - "VirtualNetworkGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity." - } - }, - "required": [ - "name", - "tier" - ], - "description": "VirtualNetworkGatewaySku details" - }, - "VirtualNetworkPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Peerings in a virtual network resource." - }, - "VirtualNetworkPeeringPropertiesFormat": { - "type": "object", - "properties": { - "allowVirtualNetworkAccess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space." - }, - "allowForwardedTraffic": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed." - }, - "allowGatewayTransit": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If gateway links can be used in remote virtual networking to link to this virtual network." - }, - "useRemoteGateways": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "remoteVirtualNetwork": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the remote virtual network." - }, - "peeringState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Initiated", - "Connected", - "Disconnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - } - }, - "VirtualNetworkPropertiesFormat": { - "type": "object", - "properties": { - "addressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." - }, - "dhcpOptions": { - "oneOf": [ - { - "$ref": "#/definitions/DhcpOptions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of subnets in a Virtual Network." - }, - "virtualNetworkPeerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of peerings in a Virtual Network." - }, - "resourceGuid": { - "type": "string", - "description": "The resourceGuid property of the Virtual Network resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "virtualNetworks_subnets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - }, - "VpnClientConfiguration": { - "type": "object", - "properties": { - "vpnClientAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the address space resource which represents Address space for P2S VpnClient." - }, - "vpnClientRootCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRootCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRootCertificate for virtual network gateway." - }, - "vpnClientRevokedCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRevokedCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRevokedCertificate for Virtual network gateway." - } - }, - "description": "VpnClientConfiguration for P2S client." - }, - "VpnClientRevokedCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "VPN client revoked certificate of virtual network gateway." - }, - "VpnClientRevokedCertificatePropertiesFormat": { - "type": "object", - "properties": { - "thumbprint": { - "type": "string", - "description": "The revoked VPN client certificate thumbprint." - } - }, - "description": "Properties of the revoked VPN client certificate of virtual network gateway." - }, - "VpnClientRootCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "VPN client root certificate of virtual network gateway" - }, - "VpnClientRootCertificatePropertiesFormat": { - "type": "object", - "properties": { - "publicCertData": { - "type": "string", - "description": "The certificate public data." - } - }, - "required": [ - "publicCertData" - ], - "description": "Properties of SSL certificates of application gateway" - } - } -} diff --git a/test/Resource/Expected/Network/2016-09-01/applicationGateways.md b/test/Resource/Expected/Network/2016-09-01/applicationGateways.md deleted file mode 100644 index 0bf46d9..0000000 --- a/test/Resource/Expected/Network/2016-09-01/applicationGateways.md +++ /dev/null @@ -1,934 +0,0 @@ -# Microsoft.Network/applicationGateways template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/applicationGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationGateways", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "sslPolicy": { - "disabledSslProtocols": [ - "string" - ] - }, - "gatewayIPConfigurations": [ - { - "id": "string", - "properties": { - "subnet": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "authenticationCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "sslCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "password": "string", - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendPorts": [ - { - "id": "string", - "properties": { - "port": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "host": "string", - "path": "string", - "interval": "integer", - "timeout": "integer", - "unhealthyThreshold": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - "ApplicationGatewayBackendAddressPool" - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendHttpSettingsCollection": [ - { - "id": "string", - "properties": { - "port": "integer", - "protocol": "string", - "cookieBasedAffinity": "string", - "requestTimeout": "integer", - "probe": { - "id": "string" - }, - "authenticationCertificates": [ - { - "id": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "httpListeners": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "frontendPort": { - "id": "string" - }, - "protocol": "string", - "hostName": "string", - "sslCertificate": { - "id": "string" - }, - "requireServerNameIndication": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "urlPathMaps": [ - { - "id": "string", - "properties": { - "defaultBackendAddressPool": { - "id": "string" - }, - "defaultBackendHttpSettings": { - "id": "string" - }, - "pathRules": [ - { - "id": "string", - "properties": { - "paths": [ - "string" - ], - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "requestRoutingRules": [ - { - "id": "string", - "properties": { - "ruleType": "string", - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "httpListener": { - "id": "string" - }, - "urlPathMap": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "webApplicationFirewallConfiguration": { - "enabled": "boolean", - "firewallMode": "string" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationGateways | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [ApplicationGatewayPropertiesFormat object](#ApplicationGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | SKU of the application gateway resource. - [ApplicationGatewaySku object](#ApplicationGatewaySku) | -| sslPolicy | object | No | SSL policy of the application gateway resource. - [ApplicationGatewaySslPolicy object](#ApplicationGatewaySslPolicy) | -| gatewayIPConfigurations | array | No | Subnets of application the gateway resource. - [ApplicationGatewayIPConfiguration object](#ApplicationGatewayIPConfiguration) | -| authenticationCertificates | array | No | Authentication certificates of the application gateway resource. - [ApplicationGatewayAuthenticationCertificate object](#ApplicationGatewayAuthenticationCertificate) | -| sslCertificates | array | No | SSL certificates of the application gateway resource. - [ApplicationGatewaySslCertificate object](#ApplicationGatewaySslCertificate) | -| frontendIPConfigurations | array | No | Frontend IP addresses of the application gateway resource. - [ApplicationGatewayFrontendIPConfiguration object](#ApplicationGatewayFrontendIPConfiguration) | -| frontendPorts | array | No | Frontend ports of the application gateway resource. - [ApplicationGatewayFrontendPort object](#ApplicationGatewayFrontendPort) | -| probes | array | No | Probes of the application gateway resource. - [ApplicationGatewayProbe object](#ApplicationGatewayProbe) | -| backendAddressPools | array | No | Backend address pool of the application gateway resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| backendHttpSettingsCollection | array | No | Backend http settings of the application gateway resource. - [ApplicationGatewayBackendHttpSettings object](#ApplicationGatewayBackendHttpSettings) | -| httpListeners | array | No | Http listeners of the application gateway resource. - [ApplicationGatewayHttpListener object](#ApplicationGatewayHttpListener) | -| urlPathMaps | array | No | URL path map of the application gateway resource. - [ApplicationGatewayUrlPathMap object](#ApplicationGatewayUrlPathMap) | -| requestRoutingRules | array | No | Request routing rules of the application gateway resource. - [ApplicationGatewayRequestRoutingRule object](#ApplicationGatewayRequestRoutingRule) | -| webApplicationFirewallConfiguration | object | No | Web application firewall configuration. - [ApplicationGatewayWebApplicationFirewallConfiguration object](#ApplicationGatewayWebApplicationFirewallConfiguration) | -| resourceGuid | string | No | Resource GUID property of the application gateway resource. | -| provisioningState | string | No | Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. - Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large | -| tier | enum | No | Tier of an application gateway. Possible values are: 'Standard' and 'WAF'. - Standard or WAF | -| capacity | integer | No | Capacity (instance count) of an application gateway. | - - - -### ApplicationGatewaySslPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disabledSslProtocols | array | No | SSL protocols to be disabled on application gateway. Possible values are: 'TLSv1_0', 'TLSv1_1', and 'TLSv1_2'. - TLSv1_0, TLSv1_1, TLSv1_2 | - - - -### ApplicationGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayIPConfigurationPropertiesFormat object](#ApplicationGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayAuthenticationCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayAuthenticationCertificatePropertiesFormat object](#ApplicationGatewayAuthenticationCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewaySslCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewaySslCertificatePropertiesFormat object](#ApplicationGatewaySslCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayFrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendIPConfigurationPropertiesFormat object](#ApplicationGatewayFrontendIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayFrontendPort object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendPortPropertiesFormat object](#ApplicationGatewayFrontendPortPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayProbe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayProbePropertiesFormat object](#ApplicationGatewayProbePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendHttpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendHttpSettingsPropertiesFormat object](#ApplicationGatewayBackendHttpSettingsPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayHttpListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayHttpListenerPropertiesFormat object](#ApplicationGatewayHttpListenerPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayUrlPathMap object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayUrlPathMapPropertiesFormat object](#ApplicationGatewayUrlPathMapPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayRequestRoutingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRequestRoutingRulePropertiesFormat object](#ApplicationGatewayRequestRoutingRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayWebApplicationFirewallConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether the web application firewall is enabled. | -| firewallMode | enum | No | Web application firewall mode. Possible values are: 'Detection' and 'Prevention'. - Detection or Prevention | - - - -### ApplicationGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Reference of the subnet resource. A subnet from where application gateway gets its private address. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayAuthenticationCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Certificate public data. | -| provisioningState | string | No | Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySslCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Base-64 encoded pfx certificate. Only applicable in PUT Request. | -| password | string | No | Password for the pfx file specified in data. Only applicable in PUT request. | -| publicCertData | string | No | Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. | -| provisioningState | string | No | Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | PrivateIPAddress of the network interface IP Configuration. | -| privateIPAllocationMethod | enum | No | PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | Reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Reference of the PublicIP resource. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendPortPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Frontend port | -| provisioningState | string | No | Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol. Possible values are: 'Http' and 'Https'. - Http or Https | -| host | string | No | Host name to send the probe to. | -| path | string | No | Relative path of probe. Valid path starts from '/'. Probe is sent to ://: | -| interval | integer | No | The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. | -| timeout | integer | No | 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 | integer | No | 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 | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendHttpSettingsPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Port | -| protocol | enum | No | Protocol. Possible values are: 'Http' and 'Https'. - Http or Https | -| cookieBasedAffinity | enum | No | Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'. - Enabled or Disabled | -| requestTimeout | integer | No | 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. | -| probe | object | No | Probe resource of an application gateway. - [SubResource object](#SubResource) | -| authenticationCertificates | array | No | Array of references to application gateway authentication certificates. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayHttpListenerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Frontend IP configuration resource of an application gateway. - [SubResource object](#SubResource) | -| frontendPort | object | No | Frontend port resource of an application gateway. - [SubResource object](#SubResource) | -| protocol | enum | No | Protocol. Possible values are: 'Http' and 'Https'. - Http or Https | -| hostName | string | No | Host name of HTTP listener. | -| sslCertificate | object | No | SSL certificate resource of an application gateway. - [SubResource object](#SubResource) | -| requireServerNameIndication | boolean | No | Applicable only if protocol is https. Enables SNI for multi-hosting. | -| provisioningState | string | No | Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayUrlPathMapPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultBackendAddressPool | object | No | Default backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| defaultBackendHttpSettings | object | No | Default backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rule of URL path map resource. - [ApplicationGatewayPathRule object](#ApplicationGatewayPathRule) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRequestRoutingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleType | enum | No | Rule type. Possible values are: 'Basic' and 'PathBasedRouting'. - Basic or PathBasedRouting | -| backendAddressPool | object | No | Backend address pool resource of the application gateway. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Frontend port resource of the application gateway. - [SubResource object](#SubResource) | -| httpListener | object | No | Http listener resource of the application gateway. - [SubResource object](#SubResource) | -| urlPathMap | object | No | URL path map resource of the application gateway. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### ApplicationGatewayPathRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayPathRulePropertiesFormat object](#ApplicationGatewayPathRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### ApplicationGatewayPathRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| paths | array | No | Path rules of URL path map. - string | -| backendAddressPool | object | No | Backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| provisioningState | string | No | Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/connections.md b/test/Resource/Expected/Network/2016-09-01/connections.md deleted file mode 100644 index 045fa5c..0000000 --- a/test/Resource/Expected/Network/2016-09-01/connections.md +++ /dev/null @@ -1,361 +0,0 @@ -# Microsoft.Network/connections template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/connections", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "authorizationKey": "string", - "virtualNetworkGateway1": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "virtualNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "localNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "connectionType": "string", - "routingWeight": "integer", - "sharedKey": "string", - "peer": { - "id": "string" - }, - "enableBgp": "boolean", - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/connections | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkGatewayConnectionPropertiesFormat object](#VirtualNetworkGatewayConnectionPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayConnectionPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorizationKey. | -| virtualNetworkGateway1 | object | Yes | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| virtualNetworkGateway2 | object | No | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| localNetworkGateway2 | object | No | [LocalNetworkGateway object](#LocalNetworkGateway) | -| connectionType | enum | Yes | Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. - IPsec, Vnet2Vnet, ExpressRoute, VPNClient | -| routingWeight | integer | No | The routing weight. | -| sharedKey | string | No | The IPSec shared key. | -| peer | object | No | The reference to peerings resource. - [SubResource object](#SubResource) | -| enableBgp | boolean | No | EnableBgp flag | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGatewayConnection resource. | - - - -### VirtualNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | Yes | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | Yes | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | Yes | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | Yes | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. - Basic, HighPerformance, Standard, UltraPerformance | -| tier | enum | Yes | Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. - Basic, HighPerformance, Standard, UltraPerformance | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | Yes | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | Yes | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2016-09-01/expressRouteCircuits.md b/test/Resource/Expected/Network/2016-09-01/expressRouteCircuits.md deleted file mode 100644 index ec53b6b..0000000 --- a/test/Resource/Expected/Network/2016-09-01/expressRouteCircuits.md +++ /dev/null @@ -1,208 +0,0 @@ -# Microsoft.Network/expressRouteCircuits template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "family": "string" - }, - "properties": { - "allowClassicOperations": "boolean", - "circuitProvisioningState": "string", - "serviceProviderProvisioningState": "string", - "authorizations": [ - { - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string" - }, - "name": "string", - "etag": "string" - } - ], - "serviceKey": "string", - "serviceProviderNotes": "string", - "serviceProviderProperties": { - "serviceProviderName": "string", - "peeringLocation": "string", - "bandwidthInMbps": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The SKU. - [ExpressRouteCircuitSku object](#ExpressRouteCircuitSku) | -| properties | object | Yes | [ExpressRouteCircuitPropertiesFormat object](#ExpressRouteCircuitPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [peerings](./expressRouteCircuits/peerings.md) [authorizations](./expressRouteCircuits/authorizations.md) | - - - -### ExpressRouteCircuitSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the SKU. | -| tier | enum | No | The tier of the SKU. Possible values are 'Standard' and 'Premium'. - Standard or Premium | -| family | enum | No | The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. - UnlimitedData or MeteredData | - - - -### ExpressRouteCircuitPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowClassicOperations | boolean | No | Allow classic operations | -| circuitProvisioningState | string | No | The CircuitProvisioningState state of the resource. | -| serviceProviderProvisioningState | enum | No | The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - NotProvisioned, Provisioning, Provisioned, Deprovisioning | -| authorizations | array | No | The list of authorizations. - [ExpressRouteCircuitAuthorization object](#ExpressRouteCircuitAuthorization) | -| peerings | array | No | The list of peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | -| serviceKey | string | No | The ServiceKey. | -| serviceProviderNotes | string | No | The ServiceProviderNotes. | -| serviceProviderProperties | object | No | The ServiceProviderProperties. - [ExpressRouteCircuitServiceProviderProperties object](#ExpressRouteCircuitServiceProviderProperties) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | - - - -### ExpressRouteCircuitAuthorization object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ExpressRouteCircuitServiceProviderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceProviderName | string | No | The serviceProviderName. | -| peeringLocation | string | No | The peering location. | -| bandwidthInMbps | integer | No | The BandwidthInMbps. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - diff --git a/test/Resource/Expected/Network/2016-09-01/expressRouteCircuits/authorizations.md b/test/Resource/Expected/Network/2016-09-01/expressRouteCircuits/authorizations.md deleted file mode 100644 index fa58e04..0000000 --- a/test/Resource/Expected/Network/2016-09-01/expressRouteCircuits/authorizations.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/authorizations template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/authorizations", - "apiVersion": "2016-09-01", - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/authorizations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/authorizations | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/expressRouteCircuits/peerings.md b/test/Resource/Expected/Network/2016-09-01/expressRouteCircuits/peerings.md deleted file mode 100644 index b2b915b..0000000 --- a/test/Resource/Expected/Network/2016-09-01/expressRouteCircuits/peerings.md +++ /dev/null @@ -1,100 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/peerings template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/peerings", - "apiVersion": "2016-09-01", - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/peerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/peerings | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - diff --git a/test/Resource/Expected/Network/2016-09-01/loadBalancers.md b/test/Resource/Expected/Network/2016-09-01/loadBalancers.md deleted file mode 100644 index c8272c2..0000000 --- a/test/Resource/Expected/Network/2016-09-01/loadBalancers.md +++ /dev/null @@ -1,592 +0,0 @@ -# Microsoft.Network/loadBalancers template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/loadBalancers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendAddressPool": { - "id": "string" - }, - "probe": { - "id": "string" - }, - "protocol": "string", - "loadDistribution": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "port": "integer", - "intervalInSeconds": "integer", - "numberOfProbes": "integer", - "requestPath": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatPools": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "backendPort": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "outboundNatRules": [ - { - "id": "string", - "properties": { - "allocatedOutboundPorts": "integer", - "frontendIPConfigurations": [ - { - "id": "string" - } - ], - "backendAddressPool": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [LoadBalancerPropertiesFormat object](#LoadBalancerPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfigurations | array | No | Object representing the frontend IPs to be used for the load balancer - [FrontendIPConfiguration object](#FrontendIPConfiguration) | -| backendAddressPools | array | No | Collection of backend address pools used by a load balancer - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancingRules | array | No | Object collection representing the load balancing rules Gets the provisioning - [LoadBalancingRule object](#LoadBalancingRule) | -| probes | array | No | Collection of probe objects used in the load balancer - [Probe object](#Probe) | -| inboundNatRules | array | No | 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. - [InboundNatRule object](#InboundNatRule) | -| inboundNatPools | array | No | 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. - [InboundNatPool object](#InboundNatPool) | -| outboundNatRules | array | No | The outbound NAT rules. - [OutboundNatRule object](#OutboundNatRule) | -| resourceGuid | string | No | The resource GUID property of the load balancer resource. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### FrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [FrontendIPConfigurationPropertiesFormat object](#FrontendIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [LoadBalancingRulePropertiesFormat object](#LoadBalancingRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Probe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ProbePropertiesFormat object](#ProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatPoolPropertiesFormat object](#InboundNatPoolPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### OutboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [OutboundNatRulePropertiesFormat object](#OutboundNatRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### FrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | The private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [Subnet object](#Subnet) | -| publicIPAddress | object | No | The reference of the Public IP resource. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### LoadBalancingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| backendAddressPool | object | No | A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| probe | object | No | The reference of the load balancer probe used by the load balancing rule. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'. - Udp or Tcp | -| loadDistribution | enum | No | The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. - Default, SourceIP, SourceIPProtocol | -| frontendPort | integer | Yes | 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. | -| backendPort | integer | No | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | Yes | 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. - Http or Tcp | -| port | integer | Yes | The port for communicating the probe. Possible values range from 1 to 65535, inclusive. | -| intervalInSeconds | integer | No | 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. | -| numberOfProbes | integer | No | 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. | -| requestPath | string | No | 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. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPortRangeStart | integer | Yes | 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. | -| frontendPortRangeEnd | integer | Yes | 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. | -| backendPort | integer | Yes | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### OutboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allocatedOutboundPorts | integer | No | The number of outbound ports to be used for NAT. | -| frontendIPConfigurations | array | No | The Frontend IP addresses of the load balancer. - [SubResource object](#SubResource) | -| backendAddressPool | object | Yes | A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/localNetworkGateways.md b/test/Resource/Expected/Network/2016-09-01/localNetworkGateways.md deleted file mode 100644 index 36b4510..0000000 --- a/test/Resource/Expected/Network/2016-09-01/localNetworkGateways.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/localNetworkGateways template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/localNetworkGateways", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/localNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/localNetworkGateways | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | Yes | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - diff --git a/test/Resource/Expected/Network/2016-09-01/networkInterfaces.md b/test/Resource/Expected/Network/2016-09-01/networkInterfaces.md deleted file mode 100644 index f0bead5..0000000 --- a/test/Resource/Expected/Network/2016-09-01/networkInterfaces.md +++ /dev/null @@ -1,557 +0,0 @@ -# Microsoft.Network/networkInterfaces template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/networkInterfaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkInterfaces", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableAcceleratedNetworking": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkInterfaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkInterfaces | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | The reference of a virtual machine. - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | A list of IPConfigurations of the network interface. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | The DNS settings in network interface. - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | The MAC address of the network interface. | -| primary | boolean | No | Gets whether this is a primary network interface on a virtual machine. | -| enableAcceleratedNetworking | boolean | No | If the network interface is accelerated networking enabled. | -| enableIPForwarding | boolean | No | Indicates whether IP forwarding is enabled on this network interface. | -| resourceGuid | string | No | The resource GUID property of the network interface resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | 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. - string | -| appliedDnsServers | array | No | 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. - string | -| internalDnsNameLabel | string | No | Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. | -| internalFqdn | string | No | Fully qualified DNS name supporting internal communications between VMs in the same virtual network. | -| internalDomainNameSuffix | string | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/networkSecurityGroups.md b/test/Resource/Expected/Network/2016-09-01/networkSecurityGroups.md deleted file mode 100644 index f7ce41c..0000000 --- a/test/Resource/Expected/Network/2016-09-01/networkSecurityGroups.md +++ /dev/null @@ -1,114 +0,0 @@ -# Microsoft.Network/networkSecurityGroups template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [securityRules](./networkSecurityGroups/securityRules.md) | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/networkSecurityGroups/securityRules.md b/test/Resource/Expected/Network/2016-09-01/networkSecurityGroups/securityRules.md deleted file mode 100644 index 2514e97..0000000 --- a/test/Resource/Expected/Network/2016-09-01/networkSecurityGroups/securityRules.md +++ /dev/null @@ -1,58 +0,0 @@ -# Microsoft.Network/networkSecurityGroups/securityRules template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups/securityRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups/securityRules", - "apiVersion": "2016-09-01", - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups/securityRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups/securityRules | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/networkWatchers.md b/test/Resource/Expected/Network/2016-09-01/networkWatchers.md deleted file mode 100644 index e625000..0000000 --- a/test/Resource/Expected/Network/2016-09-01/networkWatchers.md +++ /dev/null @@ -1,37 +0,0 @@ -# Microsoft.Network/networkWatchers template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/networkWatchers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "etag": "string", - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| properties | object | Yes | [NetworkWatcherPropertiesFormat object](#NetworkWatcherPropertiesFormat) | -| resources | array | No | [packetCaptures](./networkWatchers/packetCaptures.md) | - diff --git a/test/Resource/Expected/Network/2016-09-01/networkWatchers/packetCaptures.md b/test/Resource/Expected/Network/2016-09-01/networkWatchers/packetCaptures.md deleted file mode 100644 index 4741ad9..0000000 --- a/test/Resource/Expected/Network/2016-09-01/networkWatchers/packetCaptures.md +++ /dev/null @@ -1,78 +0,0 @@ -# Microsoft.Network/networkWatchers/packetCaptures template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers/packetCaptures", - "apiVersion": "2016-09-01", - "properties": { - "target": "string", - "bytesToCapturePerPacket": "integer", - "totalBytesPerSession": "integer", - "timeLimitInSeconds": "integer", - "storageLocation": { - "storageId": "string", - "storagePath": "string", - "filePath": "string" - }, - "filters": [ - { - "protocol": "string", - "localIPAddress": "string", - "remoteIPAddress": "string", - "localPort": "string", - "remotePort": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers/packetCaptures object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers/packetCaptures | -| apiVersion | enum | Yes | 2016-09-01 | -| properties | object | Yes | [PacketCaptureParameters object](#PacketCaptureParameters) | - - - -### PacketCaptureParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| target | string | Yes | The ID of the targeted resource, only VM is currently supported. | -| bytesToCapturePerPacket | integer | No | Number of bytes captured per packet, the remaining bytes are truncated. | -| totalBytesPerSession | integer | No | Maximum size of the capture output. | -| timeLimitInSeconds | integer | No | Maximum duration of the capture session in seconds. | -| storageLocation | object | Yes | [PacketCaptureStorageLocation object](#PacketCaptureStorageLocation) | -| filters | array | No | [PacketCaptureFilter object](#PacketCaptureFilter) | - - - -### PacketCaptureStorageLocation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageId | string | No | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | -| storagePath | string | No | 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. | -| filePath | string | No | 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. | - - - -### PacketCaptureFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol to be filtered on. - TCP, UDP, Any | -| localIPAddress | string | No | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | -| remoteIPAddress | string | No | 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 | No | 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. | -| remotePort | string | No | 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. | - diff --git a/test/Resource/Expected/Network/2016-09-01/publicIPAddresses.md b/test/Resource/Expected/Network/2016-09-01/publicIPAddresses.md deleted file mode 100644 index 186c4f4..0000000 --- a/test/Resource/Expected/Network/2016-09-01/publicIPAddresses.md +++ /dev/null @@ -1,69 +0,0 @@ -# Microsoft.Network/publicIPAddresses template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/publicIPAddresses", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/publicIPAddresses object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/publicIPAddresses | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - diff --git a/test/Resource/Expected/Network/2016-09-01/routeTables.md b/test/Resource/Expected/Network/2016-09-01/routeTables.md deleted file mode 100644 index 6c3dd9b..0000000 --- a/test/Resource/Expected/Network/2016-09-01/routeTables.md +++ /dev/null @@ -1,80 +0,0 @@ -# Microsoft.Network/routeTables template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/routeTables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [routes](./routeTables/routes.md) | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/routeTables/routes.md b/test/Resource/Expected/Network/2016-09-01/routeTables/routes.md deleted file mode 100644 index 520a29f..0000000 --- a/test/Resource/Expected/Network/2016-09-01/routeTables/routes.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Network/routeTables/routes template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/routeTables/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables/routes", - "apiVersion": "2016-09-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables/routes | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/virtualNetworkGateways.md b/test/Resource/Expected/Network/2016-09-01/virtualNetworkGateways.md deleted file mode 100644 index f92c9aa..0000000 --- a/test/Resource/Expected/Network/2016-09-01/virtualNetworkGateways.md +++ /dev/null @@ -1,207 +0,0 @@ -# Microsoft.Network/virtualNetworkGateways template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/virtualNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworkGateways", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworkGateways | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | Yes | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | Yes | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | Yes | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. - Basic, HighPerformance, Standard, UltraPerformance | -| tier | enum | Yes | Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. - Basic, HighPerformance, Standard, UltraPerformance | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | Yes | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | Yes | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2016-09-01/virtualNetworks.md b/test/Resource/Expected/Network/2016-09-01/virtualNetworks.md deleted file mode 100644 index baabaa9..0000000 --- a/test/Resource/Expected/Network/2016-09-01/virtualNetworks.md +++ /dev/null @@ -1,339 +0,0 @@ -# Microsoft.Network/virtualNetworks template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/virtualNetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks", - "apiVersion": "2016-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "addressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "string" - ] - }, - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "virtualNetworkPeerings": [ - { - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkPropertiesFormat object](#VirtualNetworkPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [virtualNetworkPeerings](./virtualNetworks/virtualNetworkPeerings.md) [subnets](./virtualNetworks/subnets.md) | - - - -### VirtualNetworkPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressSpace | object | No | The AddressSpace that contains an array of IP address ranges that can be used by subnets. - [AddressSpace object](#AddressSpace) | -| dhcpOptions | object | No | The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. - [DhcpOptions object](#DhcpOptions) | -| subnets | array | No | A list of subnets in a Virtual Network. - [Subnet object](#Subnet) | -| virtualNetworkPeerings | array | No | A list of peerings in a Virtual Network. - [VirtualNetworkPeering object](#VirtualNetworkPeering) | -| resourceGuid | string | No | The resourceGuid property of the Virtual Network resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### DhcpOptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | The list of DNS servers IP addresses. - string | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/virtualNetworks/subnets.md b/test/Resource/Expected/Network/2016-09-01/virtualNetworks/subnets.md deleted file mode 100644 index ae48f38..0000000 --- a/test/Resource/Expected/Network/2016-09-01/virtualNetworks/subnets.md +++ /dev/null @@ -1,228 +0,0 @@ -# Microsoft.Network/virtualNetworks/subnets template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/subnets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/subnets", - "apiVersion": "2016-09-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/subnets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/subnets | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-09-01/virtualNetworks/virtualNetworkPeerings.md b/test/Resource/Expected/Network/2016-09-01/virtualNetworks/virtualNetworkPeerings.md deleted file mode 100644 index 8aa84e4..0000000 --- a/test/Resource/Expected/Network/2016-09-01/virtualNetworks/virtualNetworkPeerings.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/virtualNetworks/virtualNetworkPeerings template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/virtualNetworkPeerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings", - "apiVersion": "2016-09-01", - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/virtualNetworkPeerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/virtualNetworkPeerings | -| apiVersion | enum | Yes | 2016-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - diff --git a/test/Resource/Expected/Network/2016-12-01/Microsoft.Network.json b/test/Resource/Expected/Network/2016-12-01/Microsoft.Network.json deleted file mode 100644 index bac275f..0000000 --- a/test/Resource/Expected/Network/2016-12-01/Microsoft.Network.json +++ /dev/null @@ -1,6127 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-12-01/Microsoft.Network.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Network", - "description": "Microsoft Network Resource Types", - "resourceDefinitions": { - "applicationGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationGateways" - }, - "connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/connections" - }, - "expressRouteCircuits": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/expressRouteCircuits_authorizations_childResource" - }, - { - "$ref": "#/definitions/expressRouteCircuits_peerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits" - }, - "expressRouteCircuits_authorizations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "loadBalancers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers" - }, - "localNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/localNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/localNetworkGateways" - }, - "networkInterfaces": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkInterfaces" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkInterfaces" - }, - "networkSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkSecurityGroups_securityRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups" - }, - "networkSecurityGroups_securityRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups/securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "networkWatchers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkWatcherPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkWatchers_packetCaptures_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers" - }, - "networkWatchers_packetCaptures": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers/packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "publicIPAddresses": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/publicIPAddresses" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/publicIPAddresses" - }, - "routeFilters": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeFilters_routeFilterRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters" - }, - "routeFilters_routeFilterRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters/routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "routeTables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeTables_routes_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables" - }, - "routeTables_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "virtualNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworkGateways" - }, - "virtualNetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualNetworks_subnets_childResource" - }, - { - "$ref": "#/definitions/virtualNetworks_virtualNetworkPeerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks" - }, - "virtualNetworks_subnets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - } - }, - "definitions": { - "AddressSpace": { - "type": "object", - "properties": { - "addressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of address blocks reserved for this virtual network in CIDR notation." - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." - }, - "ApplicationGatewayAuthenticationCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Authentication certificates of an application gateway." - }, - "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Certificate public data." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Authentication certificates properties of an application gateway." - }, - "ApplicationGatewayBackendAddress": { - "type": "object", - "properties": { - "fqdn": { - "type": "string", - "description": "Fully qualified domain name (FQDN)." - }, - "ipAddress": { - "type": "string", - "description": "IP address" - } - }, - "description": "Backend address of an application gateway." - }, - "ApplicationGatewayBackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of references to IPs defined in network interfaces." - }, - "backendAddresses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddress" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend addresses" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendHttpSettings": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Backend address pool settings of an application gateway." - }, - "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Port" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol. Possible values are: 'Http' and 'Https'." - }, - "cookieBasedAffinity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'." - }, - "requestTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probe resource of an application gateway." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of references to application gateway authentication certificates." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "connectionDraining": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayConnectionDraining" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connection draining of the backend http settings resource." - } - }, - "description": "Properties of Backend address pool settings of an application gateway." - }, - "ApplicationGatewayConnectionDraining": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether connection draining is enabled or not." - }, - "drainTimeoutInSec": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 3600 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." - } - }, - "required": [ - "enabled", - "drainTimeoutInSec" - ], - "description": "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." - }, - "ApplicationGatewayFrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "PrivateIPAddress of the network interface IP Configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the PublicIP resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendPort": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Frontend port of an application gateway." - }, - "ApplicationGatewayFrontendPortPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend port of an application gateway." - }, - "ApplicationGatewayHttpListener": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Http listener of an application gateway." - }, - "ApplicationGatewayHttpListenerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP configuration resource of an application gateway." - }, - "frontendPort": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of an application gateway." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol. Possible values are: 'Http' and 'Https'." - }, - "hostName": { - "type": "string", - "description": "Host name of HTTP listener." - }, - "sslCertificate": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificate resource of an application gateway." - }, - "requireServerNameIndication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of HTTP listener of an application gateway." - }, - "ApplicationGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." - }, - "ApplicationGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration of an application gateway." - }, - "ApplicationGatewayPathRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Path rule of URL path map of an application gateway." - }, - "ApplicationGatewayPathRulePropertiesFormat": { - "type": "object", - "properties": { - "paths": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules of URL path map." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of URL path map." - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings resource of URL path map." - }, - "provisioningState": { - "type": "string", - "description": "Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayProbe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Probe of the application gateway." - }, - "ApplicationGatewayProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol. Possible values are: 'Http' and 'Https'." - }, - "host": { - "type": "string", - "description": "Host name to send the probe to." - }, - "path": { - "type": "string", - "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:" - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." - }, - "timeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayPropertiesFormat": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU of the application gateway resource." - }, - "sslPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL policy of the application gateway resource." - }, - "gatewayIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnets of application the gateway resource." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Authentication certificates of the application gateway resource." - }, - "sslCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewaySslCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificates of the application gateway resource." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP addresses of the application gateway resource." - }, - "frontendPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendPort" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend ports of the application gateway resource." - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayProbe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probes of the application gateway resource." - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool of the application gateway resource." - }, - "backendHttpSettingsCollection": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings of the application gateway resource." - }, - "httpListeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayHttpListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listeners of the application gateway resource." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayUrlPathMap" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map of the application gateway resource." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing rules of the application gateway resource." - }, - "webApplicationFirewallConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall configuration." - }, - "resourceGuid": { - "type": "string", - "description": "Resource GUID property of the application gateway resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the application gateway." - }, - "ApplicationGatewayRequestRoutingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Request routing rule of an application gateway." - }, - "ApplicationGatewayRequestRoutingRulePropertiesFormat": { - "type": "object", - "properties": { - "ruleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "PathBasedRouting" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Rule type. Possible values are: 'Basic' and 'PathBasedRouting'." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of the application gateway. " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of the application gateway." - }, - "httpListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listener resource of the application gateway. " - }, - "urlPathMap": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map resource of the application gateway." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of request routing rule of the application gateway." - }, - "ApplicationGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_Small", - "Standard_Medium", - "Standard_Large", - "WAF_Medium", - "WAF_Large" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "WAF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tier of an application gateway. Possible values are: 'Standard' and 'WAF'." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity (instance count) of an application gateway." - } - }, - "description": "SKU of an application gateway" - }, - "ApplicationGatewaySslCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "SSL certificates of an application gateway." - }, - "ApplicationGatewaySslCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." - }, - "password": { - "type": "string", - "description": "Password for the pfx file specified in data. Only applicable in PUT request." - }, - "publicCertData": { - "type": "string", - "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of SSL certificates of an application gateway." - }, - "ApplicationGatewaySslPolicy": { - "type": "object", - "properties": { - "disabledSslProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL protocols to be disabled on application gateway. Possible values are: 'TLSv1_0', 'TLSv1_1', and 'TLSv1_2'." - } - }, - "description": "Application gateway SSL policy." - }, - "ApplicationGatewayUrlPathMap": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." - }, - "ApplicationGatewayUrlPathMapPropertiesFormat": { - "type": "object", - "properties": { - "defaultBackendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend address pool resource of URL path map." - }, - "defaultBackendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend http settings resource of URL path map." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayPathRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rule of URL path map resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of UrlPathMap of the application gateway." - }, - "ApplicationGatewayWebApplicationFirewallConfiguration": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the web application firewall is enabled or not." - }, - "firewallMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Detection", - "Prevention" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall mode. Possible values are: 'Detection' and 'Prevention'." - } - }, - "required": [ - "enabled" - ], - "description": "Application gateway web application firewall configuration." - }, - "AuthorizationPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorization key." - }, - "authorizationUseStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Available", - "InUse" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "BackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Pool of backend IP addresses." - }, - "BackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "description": "Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the backend address pool." - }, - "BgpSettings": { - "type": "object", - "properties": { - "asn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BGP speaker's ASN." - }, - "bgpPeeringAddress": { - "type": "string", - "description": "The BGP peering address and BGP identifier of this BGP speaker." - }, - "peerWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The weight added to routes learned from this BGP speaker." - } - } - }, - "DhcpOptions": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of DNS servers IP addresses." - } - }, - "description": "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." - }, - "ExpressRouteCircuitAuthorization": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Authorization in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Peering in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "advertisedPublicPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of AdvertisedPublicPrefixes." - }, - "advertisedPublicPrefixesState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotConfigured", - "Configuring", - "Configured", - "ValidationNeeded" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'." - }, - "customerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CustomerASN of the peering." - }, - "routingRegistryName": { - "type": "string", - "description": "The RoutingRegistryName of the configuration." - } - }, - "description": "Specifies the peering configuration." - }, - "ExpressRouteCircuitPeeringPropertiesFormat": { - "type": "object", - "properties": { - "peeringType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzurePublicPeering", - "AzurePrivatePeering", - "MicrosoftPeering" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - }, - "azureASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Azure ASN." - }, - "peerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The peer ASN." - }, - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "primaryAzurePort": { - "type": "string", - "description": "The primary port." - }, - "secondaryAzurePort": { - "type": "string", - "description": "The secondary port." - }, - "sharedKey": { - "type": "string", - "description": "The shared key." - }, - "vlanId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The VLAN ID." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "stats": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitStats" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets peering stats." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets whether the provider or the customer last modified the peering." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - } - } - }, - "ExpressRouteCircuitPropertiesFormat": { - "type": "object", - "properties": { - "allowClassicOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allow classic operations" - }, - "circuitProvisioningState": { - "type": "string", - "description": "The CircuitProvisioningState state of the resource." - }, - "serviceProviderProvisioningState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotProvisioned", - "Provisioning", - "Provisioned", - "Deprovisioning" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'." - }, - "authorizations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitAuthorization" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of authorizations." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of peerings." - }, - "serviceKey": { - "type": "string", - "description": "The ServiceKey." - }, - "serviceProviderNotes": { - "type": "string", - "description": "The ServiceProviderNotes." - }, - "serviceProviderProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProperties." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - } - }, - "description": "Properties of ExpressRouteCircuit." - }, - "ExpressRouteCircuitServiceProviderProperties": { - "type": "object", - "properties": { - "serviceProviderName": { - "type": "string", - "description": "The serviceProviderName." - }, - "peeringLocation": { - "type": "string", - "description": "The peering location." - }, - "bandwidthInMbps": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BandwidthInMbps." - } - }, - "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tier of the SKU. Possible values are 'Standard' and 'Premium'." - }, - "family": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UnlimitedData", - "MeteredData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'." - } - }, - "description": "Contains SKU in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitStats": { - "type": "object", - "properties": { - "primarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "primarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - }, - "secondarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "secondarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - } - }, - "description": "Contains stats associated with the peering." - }, - "expressRouteCircuits_authorizations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "FrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Frontend IP address of the load balancer." - }, - "FrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "The private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the Public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP Configuration of the load balancer." - }, - "InboundNatPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT pool of the load balancer." - }, - "InboundNatPoolPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPortRangeStart", - "frontendPortRangeEnd", - "backendPort" - ], - "description": "Properties of Inbound NAT pool." - }, - "InboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT rule of the load balancer." - }, - "InboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the inbound NAT rule." - }, - "LoadBalancerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/FrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object representing the frontend IPs to be used for the load balancer" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of backend address pools used by a load balancer" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object collection representing the load balancing rules Gets the provisioning " - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Probe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of probe objects used in the load balancer" - }, - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/OutboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The outbound NAT rules." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the load balancer resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the load balancer." - }, - "LoadBalancingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancing rule for a load balancer." - }, - "LoadBalancingRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the load balancer probe used by the load balancing rule." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'." - }, - "loadDistribution": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "SourceIP", - "SourceIPProtocol" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. " - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPort" - ], - "description": "Properties of the load balancer." - }, - "LocalNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "LocalNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "localNetworkAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network site address space." - }, - "gatewayIpAddress": { - "type": "string", - "description": "IP address of local network gateway." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the LocalNetworkGateway resource." - } - }, - "description": "LocalNetworkGateway properties" - }, - "NetworkInterfaceDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "appliedDnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "internalDnsNameLabel": { - "type": "string", - "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." - }, - "internalFqdn": { - "type": "string", - "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." - }, - "internalDomainNameSuffix": { - "type": "string", - "description": "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." - } - }, - "description": "DNS settings of a network interface." - }, - "NetworkInterfaceIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IPConfiguration in a network interface." - }, - "NetworkInterfaceIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of ApplicationGatewayBackendAddressPool resource." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of LoadBalancerBackendAddressPool resource." - }, - "loadBalancerInboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references of LoadBalancerInboundNatRules." - }, - "privateIPAddress": { - "type": "string" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary customer address on the network interface." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "provisioningState": { - "type": "string" - } - }, - "description": "Properties of IP configuration." - }, - "NetworkInterfacePropertiesFormat": { - "type": "object", - "properties": { - "virtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of a virtual machine." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of IPConfigurations of the network interface." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DNS settings in network interface." - }, - "macAddress": { - "type": "string", - "description": "The MAC address of the network interface." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary network interface on a virtual machine." - }, - "enableAcceleratedNetworking": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the network interface is accelerated networking enabled." - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether IP forwarding is enabled on this network interface." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network interface resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "NetworkInterface properties. " - }, - "NetworkSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "NetworkSecurityGroup resource." - }, - "NetworkSecurityGroupPropertiesFormat": { - "type": "object", - "properties": { - "securityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of security rules of the network security group." - }, - "defaultSecurityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The default security rules of network security group." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network security group resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Network Security Group resource." - }, - "networkSecurityGroups_securityRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "NetworkWatcherPropertiesFormat": { - "type": "object", - "properties": {}, - "description": "The network watcher properties." - }, - "networkWatchers_packetCaptures_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "OutboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OutboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Outbound NAT pool of the load balancer." - }, - "OutboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "allocatedOutboundPorts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of outbound ports to be used for NAT." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Frontend IP addresses of the load balancer." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "backendAddressPool" - ], - "description": "Outbound NAT pool of the load balancer." - }, - "PacketCaptureFilter": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TCP", - "UDP", - "Any" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol to be filtered on." - }, - "localIPAddress": { - "type": "string", - "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." - }, - "remoteIPAddress": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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." - }, - "remotePort": { - "type": "string", - "description": "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." - } - }, - "description": "Filter that is applied to packet capture request. Multiple filters can be applied." - }, - "PacketCaptureParameters": { - "type": "object", - "properties": { - "target": { - "type": "string", - "description": "The ID of the targeted resource, only VM is currently supported." - }, - "bytesToCapturePerPacket": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of bytes captured per packet, the remaining bytes are truncated." - }, - "totalBytesPerSession": { - "oneOf": [ - { - "type": "integer", - "default": "1073741824" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum size of the capture output." - }, - "timeLimitInSeconds": { - "oneOf": [ - { - "type": "integer", - "default": "18000" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum duration of the capture session in seconds." - }, - "storageLocation": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureStorageLocation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "filters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PacketCaptureFilter" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "target", - "storageLocation" - ], - "description": "Parameters that define the create packet capture operation." - }, - "PacketCaptureStorageLocation": { - "type": "object", - "properties": { - "storageId": { - "type": "string", - "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." - }, - "storagePath": { - "type": "string", - "description": "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." - }, - "filePath": { - "type": "string", - "description": "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." - } - }, - "description": "Describes the storage location for a packet capture session." - }, - "Probe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancer probe." - }, - "ProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." - }, - "intervalInSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "numberOfProbes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "requestPath": { - "type": "string", - "description": "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." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "port" - ] - }, - "PublicIPAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Public IP address resource." - }, - "PublicIPAddressDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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. " - } - }, - "description": "Contains FQDN of the DNS record associated with the public IP address" - }, - "PublicIPAddressPropertiesFormat": { - "type": "object", - "properties": { - "publicIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "publicIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The FQDN of the DNS record associated with the public IP address." - }, - "ipAddress": { - "type": "string" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The idle timeout of the public IP address." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Public IP address properties." - }, - "ResourceNavigationLink": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceNavigationLinkFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "ResourceNavigationLink resource." - }, - "ResourceNavigationLinkFormat": { - "type": "object", - "properties": { - "linkedResourceType": { - "type": "string", - "description": "Resource type of the linked resource." - }, - "link": { - "type": "string", - "description": "Link to the external resource" - } - }, - "description": "Properties of ResourceNavigationLink." - }, - "Route": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route resource" - }, - "RouteFilter": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Route Filter Resource." - }, - "RouteFilterPropertiesFormat": { - "type": "object", - "properties": { - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RouteFilterRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of RouteFilterRules contained within a route filter." - } - }, - "description": "Route Filter Resource" - }, - "RouteFilterRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "description": "Route Filter Rule Resource" - }, - "RouteFilterRulePropertiesFormat": { - "type": "object", - "properties": { - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The access type of the rule. Valid values are: 'Allow', 'Deny'." - }, - "routeFilterRuleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Community" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The rule type of the rule. Valid value is: 'Community'" - }, - "communities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']" - } - }, - "required": [ - "access", - "routeFilterRuleType", - "communities" - ], - "description": "Route Filter Rule Resource" - }, - "routeFilters_routeFilterRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "RoutePropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The destination CIDR to which the route applies." - }, - "nextHopType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VirtualNetworkGateway", - "VnetLocal", - "Internet", - "VirtualAppliance", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'." - }, - "nextHopIpAddress": { - "type": "string", - "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "nextHopType" - ], - "description": "Route resource" - }, - "RouteTable": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route table resource." - }, - "RouteTablePropertiesFormat": { - "type": "object", - "properties": { - "routes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Route" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of routes contained within a route table." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Route Table resource" - }, - "routeTables_routes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "SecurityRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Network security rule." - }, - "SecurityRulePropertiesFormat": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description for this rule. Restricted to 140 chars." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp", - "*" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'." - }, - "sourcePortRange": { - "type": "string", - "description": "The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "destinationPortRange": { - "type": "string", - "description": "The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "sourceAddressPrefix": { - "type": "string", - "description": "The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " - }, - "destinationAddressPrefix": { - "type": "string", - "description": "The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'." - }, - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "sourceAddressPrefix", - "destinationAddressPrefix", - "access", - "direction" - ] - }, - "Subnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Subnet in a virtual network resource." - }, - "SubnetPropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The address prefix for the subnet." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "routeTable": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTable" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteTable resource." - }, - "resourceNavigationLinks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceNavigationLink" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets an array of references to the external resources using subnet." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - } - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - } - } - }, - "VirtualNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "VirtualNetworkGatewayConnectionPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorizationKey." - }, - "virtualNetworkGateway1": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "virtualNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "localNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "connectionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPsec", - "Vnet2Vnet", - "ExpressRoute", - "VPNClient" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient." - }, - "routingWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The routing weight." - }, - "sharedKey": { - "type": "string", - "description": "The IPSec shared key." - }, - "peer": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to peerings resource." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp flag" - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." - } - }, - "required": [ - "virtualNetworkGateway1", - "connectionType" - ], - "description": "VirtualNetworkGatewayConnection properties" - }, - "VirtualNetworkGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration for virtual network gateway" - }, - "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the public IP resource." - } - }, - "description": "Properties of VirtualNetworkGatewayIPConfiguration" - }, - "VirtualNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IP configurations for virtual network gateway." - }, - "gatewayType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Vpn", - "ExpressRoute" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PolicyBased", - "RouteBased" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether BGP is enabled for this virtual network gateway or not." - }, - "activeActive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "ActiveActive flag" - }, - "gatewayDefaultSite": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." - }, - "vpnClientConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGateway resource." - } - }, - "description": "VirtualNetworkGateway properties" - }, - "VirtualNetworkGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity." - } - }, - "description": "VirtualNetworkGatewaySku details" - }, - "VirtualNetworkPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Peerings in a virtual network resource." - }, - "VirtualNetworkPeeringPropertiesFormat": { - "type": "object", - "properties": { - "allowVirtualNetworkAccess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space." - }, - "allowForwardedTraffic": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed." - }, - "allowGatewayTransit": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If gateway links can be used in remote virtual networking to link to this virtual network." - }, - "useRemoteGateways": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "remoteVirtualNetwork": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the remote virtual network." - }, - "peeringState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Initiated", - "Connected", - "Disconnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - } - }, - "VirtualNetworkPropertiesFormat": { - "type": "object", - "properties": { - "addressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." - }, - "dhcpOptions": { - "oneOf": [ - { - "$ref": "#/definitions/DhcpOptions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of subnets in a Virtual Network." - }, - "virtualNetworkPeerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of peerings in a Virtual Network." - }, - "resourceGuid": { - "type": "string", - "description": "The resourceGuid property of the Virtual Network resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "virtualNetworks_subnets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - }, - "VpnClientConfiguration": { - "type": "object", - "properties": { - "vpnClientAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the address space resource which represents Address space for P2S VpnClient." - }, - "vpnClientRootCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRootCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRootCertificate for virtual network gateway." - }, - "vpnClientRevokedCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRevokedCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRevokedCertificate for Virtual network gateway." - } - }, - "description": "VpnClientConfiguration for P2S client." - }, - "VpnClientRevokedCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "VPN client revoked certificate of virtual network gateway." - }, - "VpnClientRevokedCertificatePropertiesFormat": { - "type": "object", - "properties": { - "thumbprint": { - "type": "string", - "description": "The revoked VPN client certificate thumbprint." - } - }, - "description": "Properties of the revoked VPN client certificate of virtual network gateway." - }, - "VpnClientRootCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "VPN client root certificate of virtual network gateway" - }, - "VpnClientRootCertificatePropertiesFormat": { - "type": "object", - "properties": { - "publicCertData": { - "type": "string", - "description": "The certificate public data." - } - }, - "required": [ - "publicCertData" - ], - "description": "Properties of SSL certificates of application gateway" - } - } -} diff --git a/test/Resource/Expected/Network/2016-12-01/applicationGateways.md b/test/Resource/Expected/Network/2016-12-01/applicationGateways.md deleted file mode 100644 index 31d835b..0000000 --- a/test/Resource/Expected/Network/2016-12-01/applicationGateways.md +++ /dev/null @@ -1,947 +0,0 @@ -# Microsoft.Network/applicationGateways template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/applicationGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationGateways", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "sslPolicy": { - "disabledSslProtocols": [ - "string" - ] - }, - "gatewayIPConfigurations": [ - { - "id": "string", - "properties": { - "subnet": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "authenticationCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "sslCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "password": "string", - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendPorts": [ - { - "id": "string", - "properties": { - "port": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "host": "string", - "path": "string", - "interval": "integer", - "timeout": "integer", - "unhealthyThreshold": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - "ApplicationGatewayBackendAddressPool" - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendHttpSettingsCollection": [ - { - "id": "string", - "properties": { - "port": "integer", - "protocol": "string", - "cookieBasedAffinity": "string", - "requestTimeout": "integer", - "probe": { - "id": "string" - }, - "authenticationCertificates": [ - { - "id": "string" - } - ], - "provisioningState": "string", - "connectionDraining": { - "enabled": "boolean", - "drainTimeoutInSec": "integer" - } - }, - "name": "string", - "etag": "string" - } - ], - "httpListeners": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "frontendPort": { - "id": "string" - }, - "protocol": "string", - "hostName": "string", - "sslCertificate": { - "id": "string" - }, - "requireServerNameIndication": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "urlPathMaps": [ - { - "id": "string", - "properties": { - "defaultBackendAddressPool": { - "id": "string" - }, - "defaultBackendHttpSettings": { - "id": "string" - }, - "pathRules": [ - { - "id": "string", - "properties": { - "paths": [ - "string" - ], - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "requestRoutingRules": [ - { - "id": "string", - "properties": { - "ruleType": "string", - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "httpListener": { - "id": "string" - }, - "urlPathMap": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "webApplicationFirewallConfiguration": { - "enabled": "boolean", - "firewallMode": "string" - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationGateways | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [ApplicationGatewayPropertiesFormat object](#ApplicationGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | SKU of the application gateway resource. - [ApplicationGatewaySku object](#ApplicationGatewaySku) | -| sslPolicy | object | No | SSL policy of the application gateway resource. - [ApplicationGatewaySslPolicy object](#ApplicationGatewaySslPolicy) | -| gatewayIPConfigurations | array | No | Subnets of application the gateway resource. - [ApplicationGatewayIPConfiguration object](#ApplicationGatewayIPConfiguration) | -| authenticationCertificates | array | No | Authentication certificates of the application gateway resource. - [ApplicationGatewayAuthenticationCertificate object](#ApplicationGatewayAuthenticationCertificate) | -| sslCertificates | array | No | SSL certificates of the application gateway resource. - [ApplicationGatewaySslCertificate object](#ApplicationGatewaySslCertificate) | -| frontendIPConfigurations | array | No | Frontend IP addresses of the application gateway resource. - [ApplicationGatewayFrontendIPConfiguration object](#ApplicationGatewayFrontendIPConfiguration) | -| frontendPorts | array | No | Frontend ports of the application gateway resource. - [ApplicationGatewayFrontendPort object](#ApplicationGatewayFrontendPort) | -| probes | array | No | Probes of the application gateway resource. - [ApplicationGatewayProbe object](#ApplicationGatewayProbe) | -| backendAddressPools | array | No | Backend address pool of the application gateway resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| backendHttpSettingsCollection | array | No | Backend http settings of the application gateway resource. - [ApplicationGatewayBackendHttpSettings object](#ApplicationGatewayBackendHttpSettings) | -| httpListeners | array | No | Http listeners of the application gateway resource. - [ApplicationGatewayHttpListener object](#ApplicationGatewayHttpListener) | -| urlPathMaps | array | No | URL path map of the application gateway resource. - [ApplicationGatewayUrlPathMap object](#ApplicationGatewayUrlPathMap) | -| requestRoutingRules | array | No | Request routing rules of the application gateway resource. - [ApplicationGatewayRequestRoutingRule object](#ApplicationGatewayRequestRoutingRule) | -| webApplicationFirewallConfiguration | object | No | Web application firewall configuration. - [ApplicationGatewayWebApplicationFirewallConfiguration object](#ApplicationGatewayWebApplicationFirewallConfiguration) | -| resourceGuid | string | No | Resource GUID property of the application gateway resource. | -| provisioningState | string | No | Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. - Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large | -| tier | enum | No | Tier of an application gateway. Possible values are: 'Standard' and 'WAF'. - Standard or WAF | -| capacity | integer | No | Capacity (instance count) of an application gateway. | - - - -### ApplicationGatewaySslPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disabledSslProtocols | array | No | SSL protocols to be disabled on application gateway. Possible values are: 'TLSv1_0', 'TLSv1_1', and 'TLSv1_2'. - TLSv1_0, TLSv1_1, TLSv1_2 | - - - -### ApplicationGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayIPConfigurationPropertiesFormat object](#ApplicationGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayAuthenticationCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayAuthenticationCertificatePropertiesFormat object](#ApplicationGatewayAuthenticationCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewaySslCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewaySslCertificatePropertiesFormat object](#ApplicationGatewaySslCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayFrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendIPConfigurationPropertiesFormat object](#ApplicationGatewayFrontendIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayFrontendPort object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendPortPropertiesFormat object](#ApplicationGatewayFrontendPortPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayProbe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayProbePropertiesFormat object](#ApplicationGatewayProbePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendHttpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendHttpSettingsPropertiesFormat object](#ApplicationGatewayBackendHttpSettingsPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayHttpListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayHttpListenerPropertiesFormat object](#ApplicationGatewayHttpListenerPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayUrlPathMap object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayUrlPathMapPropertiesFormat object](#ApplicationGatewayUrlPathMapPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayRequestRoutingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRequestRoutingRulePropertiesFormat object](#ApplicationGatewayRequestRoutingRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayWebApplicationFirewallConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether the web application firewall is enabled or not. | -| firewallMode | enum | No | Web application firewall mode. Possible values are: 'Detection' and 'Prevention'. - Detection or Prevention | - - - -### ApplicationGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Reference of the subnet resource. A subnet from where application gateway gets its private address. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayAuthenticationCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Certificate public data. | -| provisioningState | string | No | Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySslCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Base-64 encoded pfx certificate. Only applicable in PUT Request. | -| password | string | No | Password for the pfx file specified in data. Only applicable in PUT request. | -| publicCertData | string | No | Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. | -| provisioningState | string | No | Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | PrivateIPAddress of the network interface IP Configuration. | -| privateIPAllocationMethod | enum | No | PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | Reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Reference of the PublicIP resource. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendPortPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Frontend port | -| provisioningState | string | No | Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol. Possible values are: 'Http' and 'Https'. - Http or Https | -| host | string | No | Host name to send the probe to. | -| path | string | No | Relative path of probe. Valid path starts from '/'. Probe is sent to ://: | -| interval | integer | No | The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. | -| timeout | integer | No | 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 | integer | No | 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 | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendHttpSettingsPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Port | -| protocol | enum | No | Protocol. Possible values are: 'Http' and 'Https'. - Http or Https | -| cookieBasedAffinity | enum | No | Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'. - Enabled or Disabled | -| requestTimeout | integer | No | 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. | -| probe | object | No | Probe resource of an application gateway. - [SubResource object](#SubResource) | -| authenticationCertificates | array | No | Array of references to application gateway authentication certificates. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| connectionDraining | object | No | Connection draining of the backend http settings resource. - [ApplicationGatewayConnectionDraining object](#ApplicationGatewayConnectionDraining) | - - - -### ApplicationGatewayHttpListenerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Frontend IP configuration resource of an application gateway. - [SubResource object](#SubResource) | -| frontendPort | object | No | Frontend port resource of an application gateway. - [SubResource object](#SubResource) | -| protocol | enum | No | Protocol. Possible values are: 'Http' and 'Https'. - Http or Https | -| hostName | string | No | Host name of HTTP listener. | -| sslCertificate | object | No | SSL certificate resource of an application gateway. - [SubResource object](#SubResource) | -| requireServerNameIndication | boolean | No | Applicable only if protocol is https. Enables SNI for multi-hosting. | -| provisioningState | string | No | Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayUrlPathMapPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultBackendAddressPool | object | No | Default backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| defaultBackendHttpSettings | object | No | Default backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rule of URL path map resource. - [ApplicationGatewayPathRule object](#ApplicationGatewayPathRule) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRequestRoutingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleType | enum | No | Rule type. Possible values are: 'Basic' and 'PathBasedRouting'. - Basic or PathBasedRouting | -| backendAddressPool | object | No | Backend address pool resource of the application gateway. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Frontend port resource of the application gateway. - [SubResource object](#SubResource) | -| httpListener | object | No | Http listener resource of the application gateway. - [SubResource object](#SubResource) | -| urlPathMap | object | No | URL path map resource of the application gateway. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### ApplicationGatewayConnectionDraining object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether connection draining is enabled or not. | -| drainTimeoutInSec | integer | Yes | The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. | - - - -### ApplicationGatewayPathRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayPathRulePropertiesFormat object](#ApplicationGatewayPathRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### ApplicationGatewayPathRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| paths | array | No | Path rules of URL path map. - string | -| backendAddressPool | object | No | Backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| provisioningState | string | No | Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/connections.md b/test/Resource/Expected/Network/2016-12-01/connections.md deleted file mode 100644 index 3820e00..0000000 --- a/test/Resource/Expected/Network/2016-12-01/connections.md +++ /dev/null @@ -1,361 +0,0 @@ -# Microsoft.Network/connections template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/connections", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "authorizationKey": "string", - "virtualNetworkGateway1": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "virtualNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "localNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "connectionType": "string", - "routingWeight": "integer", - "sharedKey": "string", - "peer": { - "id": "string" - }, - "enableBgp": "boolean", - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/connections | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkGatewayConnectionPropertiesFormat object](#VirtualNetworkGatewayConnectionPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayConnectionPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorizationKey. | -| virtualNetworkGateway1 | object | Yes | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| virtualNetworkGateway2 | object | No | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| localNetworkGateway2 | object | No | [LocalNetworkGateway object](#LocalNetworkGateway) | -| connectionType | enum | Yes | Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. - IPsec, Vnet2Vnet, ExpressRoute, VPNClient | -| routingWeight | integer | No | The routing weight. | -| sharedKey | string | No | The IPSec shared key. | -| peer | object | No | The reference to peerings resource. - [SubResource object](#SubResource) | -| enableBgp | boolean | No | EnableBgp flag | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGatewayConnection resource. | - - - -### VirtualNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. - Basic, HighPerformance, Standard, UltraPerformance | -| tier | enum | No | Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. - Basic, HighPerformance, Standard, UltraPerformance | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2016-12-01/expressRouteCircuits.md b/test/Resource/Expected/Network/2016-12-01/expressRouteCircuits.md deleted file mode 100644 index ac9bf51..0000000 --- a/test/Resource/Expected/Network/2016-12-01/expressRouteCircuits.md +++ /dev/null @@ -1,260 +0,0 @@ -# Microsoft.Network/expressRouteCircuits template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "family": "string" - }, - "properties": { - "allowClassicOperations": "boolean", - "circuitProvisioningState": "string", - "serviceProviderProvisioningState": "string", - "authorizations": [ - { - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "name": "string" - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} - } - ] - } - } - }, - "name": "string" - } - ], - "serviceKey": "string", - "serviceProviderNotes": "string", - "serviceProviderProperties": { - "serviceProviderName": "string", - "peeringLocation": "string", - "bandwidthInMbps": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The SKU. - [ExpressRouteCircuitSku object](#ExpressRouteCircuitSku) | -| properties | object | Yes | [ExpressRouteCircuitPropertiesFormat object](#ExpressRouteCircuitPropertiesFormat) | -| resources | array | No | [peerings](./expressRouteCircuits/peerings.md) [authorizations](./expressRouteCircuits/authorizations.md) | - - - -### ExpressRouteCircuitSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the SKU. | -| tier | enum | No | The tier of the SKU. Possible values are 'Standard' and 'Premium'. - Standard or Premium | -| family | enum | No | The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. - UnlimitedData or MeteredData | - - - -### ExpressRouteCircuitPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowClassicOperations | boolean | No | Allow classic operations | -| circuitProvisioningState | string | No | The CircuitProvisioningState state of the resource. | -| serviceProviderProvisioningState | enum | No | The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - NotProvisioned, Provisioning, Provisioned, Deprovisioning | -| authorizations | array | No | The list of authorizations. - [ExpressRouteCircuitAuthorization object](#ExpressRouteCircuitAuthorization) | -| peerings | array | No | The list of peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | -| serviceKey | string | No | The ServiceKey. | -| serviceProviderNotes | string | No | The ServiceProviderNotes. | -| serviceProviderProperties | object | No | The ServiceProviderProperties. - [ExpressRouteCircuitServiceProviderProperties object](#ExpressRouteCircuitServiceProviderProperties) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | - - - -### ExpressRouteCircuitAuthorization object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitServiceProviderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceProviderName | string | No | The serviceProviderName. | -| peeringLocation | string | No | The peering location. | -| bandwidthInMbps | integer | No | The BandwidthInMbps. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2016-12-01/expressRouteCircuits/authorizations.md b/test/Resource/Expected/Network/2016-12-01/expressRouteCircuits/authorizations.md deleted file mode 100644 index 8dd9950..0000000 --- a/test/Resource/Expected/Network/2016-12-01/expressRouteCircuits/authorizations.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/authorizations template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/authorizations", - "apiVersion": "2016-12-01", - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/authorizations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/authorizations | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/expressRouteCircuits/peerings.md b/test/Resource/Expected/Network/2016-12-01/expressRouteCircuits/peerings.md deleted file mode 100644 index 768f488..0000000 --- a/test/Resource/Expected/Network/2016-12-01/expressRouteCircuits/peerings.md +++ /dev/null @@ -1,156 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/peerings template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/peerings", - "apiVersion": "2016-12-01", - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} - } - ] - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/peerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/peerings | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2016-12-01/loadBalancers.md b/test/Resource/Expected/Network/2016-12-01/loadBalancers.md deleted file mode 100644 index e7d56e3..0000000 --- a/test/Resource/Expected/Network/2016-12-01/loadBalancers.md +++ /dev/null @@ -1,592 +0,0 @@ -# Microsoft.Network/loadBalancers template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/loadBalancers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendAddressPool": { - "id": "string" - }, - "probe": { - "id": "string" - }, - "protocol": "string", - "loadDistribution": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "port": "integer", - "intervalInSeconds": "integer", - "numberOfProbes": "integer", - "requestPath": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatPools": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "backendPort": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "outboundNatRules": [ - { - "id": "string", - "properties": { - "allocatedOutboundPorts": "integer", - "frontendIPConfigurations": [ - { - "id": "string" - } - ], - "backendAddressPool": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [LoadBalancerPropertiesFormat object](#LoadBalancerPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfigurations | array | No | Object representing the frontend IPs to be used for the load balancer - [FrontendIPConfiguration object](#FrontendIPConfiguration) | -| backendAddressPools | array | No | Collection of backend address pools used by a load balancer - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancingRules | array | No | Object collection representing the load balancing rules Gets the provisioning - [LoadBalancingRule object](#LoadBalancingRule) | -| probes | array | No | Collection of probe objects used in the load balancer - [Probe object](#Probe) | -| inboundNatRules | array | No | 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. - [InboundNatRule object](#InboundNatRule) | -| inboundNatPools | array | No | 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. - [InboundNatPool object](#InboundNatPool) | -| outboundNatRules | array | No | The outbound NAT rules. - [OutboundNatRule object](#OutboundNatRule) | -| resourceGuid | string | No | The resource GUID property of the load balancer resource. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### FrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [FrontendIPConfigurationPropertiesFormat object](#FrontendIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [LoadBalancingRulePropertiesFormat object](#LoadBalancingRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Probe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ProbePropertiesFormat object](#ProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatPoolPropertiesFormat object](#InboundNatPoolPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### OutboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [OutboundNatRulePropertiesFormat object](#OutboundNatRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### FrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | The private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [Subnet object](#Subnet) | -| publicIPAddress | object | No | The reference of the Public IP resource. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### LoadBalancingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| backendAddressPool | object | No | A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| probe | object | No | The reference of the load balancer probe used by the load balancing rule. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'. - Udp or Tcp | -| loadDistribution | enum | No | The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. - Default, SourceIP, SourceIPProtocol | -| frontendPort | integer | Yes | 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. | -| backendPort | integer | No | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | Yes | 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. - Http or Tcp | -| port | integer | Yes | The port for communicating the probe. Possible values range from 1 to 65535, inclusive. | -| intervalInSeconds | integer | No | 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. | -| numberOfProbes | integer | No | 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. | -| requestPath | string | No | 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. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPortRangeStart | integer | Yes | 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. | -| frontendPortRangeEnd | integer | Yes | 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. | -| backendPort | integer | Yes | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### OutboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allocatedOutboundPorts | integer | No | The number of outbound ports to be used for NAT. | -| frontendIPConfigurations | array | No | The Frontend IP addresses of the load balancer. - [SubResource object](#SubResource) | -| backendAddressPool | object | Yes | A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/localNetworkGateways.md b/test/Resource/Expected/Network/2016-12-01/localNetworkGateways.md deleted file mode 100644 index fe9b567..0000000 --- a/test/Resource/Expected/Network/2016-12-01/localNetworkGateways.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/localNetworkGateways template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/localNetworkGateways", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/localNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/localNetworkGateways | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - diff --git a/test/Resource/Expected/Network/2016-12-01/networkInterfaces.md b/test/Resource/Expected/Network/2016-12-01/networkInterfaces.md deleted file mode 100644 index 9dd6d93..0000000 --- a/test/Resource/Expected/Network/2016-12-01/networkInterfaces.md +++ /dev/null @@ -1,557 +0,0 @@ -# Microsoft.Network/networkInterfaces template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/networkInterfaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkInterfaces", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableAcceleratedNetworking": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkInterfaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkInterfaces | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | The reference of a virtual machine. - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | A list of IPConfigurations of the network interface. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | The DNS settings in network interface. - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | The MAC address of the network interface. | -| primary | boolean | No | Gets whether this is a primary network interface on a virtual machine. | -| enableAcceleratedNetworking | boolean | No | If the network interface is accelerated networking enabled. | -| enableIPForwarding | boolean | No | Indicates whether IP forwarding is enabled on this network interface. | -| resourceGuid | string | No | The resource GUID property of the network interface resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | 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. - string | -| appliedDnsServers | array | No | 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. - string | -| internalDnsNameLabel | string | No | Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. | -| internalFqdn | string | No | Fully qualified DNS name supporting internal communications between VMs in the same virtual network. | -| internalDomainNameSuffix | string | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/networkSecurityGroups.md b/test/Resource/Expected/Network/2016-12-01/networkSecurityGroups.md deleted file mode 100644 index 1858424..0000000 --- a/test/Resource/Expected/Network/2016-12-01/networkSecurityGroups.md +++ /dev/null @@ -1,114 +0,0 @@ -# Microsoft.Network/networkSecurityGroups template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [securityRules](./networkSecurityGroups/securityRules.md) | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/networkSecurityGroups/securityRules.md b/test/Resource/Expected/Network/2016-12-01/networkSecurityGroups/securityRules.md deleted file mode 100644 index b997030..0000000 --- a/test/Resource/Expected/Network/2016-12-01/networkSecurityGroups/securityRules.md +++ /dev/null @@ -1,58 +0,0 @@ -# Microsoft.Network/networkSecurityGroups/securityRules template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups/securityRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups/securityRules", - "apiVersion": "2016-12-01", - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups/securityRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups/securityRules | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/networkWatchers.md b/test/Resource/Expected/Network/2016-12-01/networkWatchers.md deleted file mode 100644 index 5e1c426..0000000 --- a/test/Resource/Expected/Network/2016-12-01/networkWatchers.md +++ /dev/null @@ -1,37 +0,0 @@ -# Microsoft.Network/networkWatchers template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/networkWatchers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "etag": "string", - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| properties | object | Yes | [NetworkWatcherPropertiesFormat object](#NetworkWatcherPropertiesFormat) | -| resources | array | No | [packetCaptures](./networkWatchers/packetCaptures.md) | - diff --git a/test/Resource/Expected/Network/2016-12-01/networkWatchers/packetCaptures.md b/test/Resource/Expected/Network/2016-12-01/networkWatchers/packetCaptures.md deleted file mode 100644 index b908ff5..0000000 --- a/test/Resource/Expected/Network/2016-12-01/networkWatchers/packetCaptures.md +++ /dev/null @@ -1,78 +0,0 @@ -# Microsoft.Network/networkWatchers/packetCaptures template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers/packetCaptures", - "apiVersion": "2016-12-01", - "properties": { - "target": "string", - "bytesToCapturePerPacket": "integer", - "totalBytesPerSession": "integer", - "timeLimitInSeconds": "integer", - "storageLocation": { - "storageId": "string", - "storagePath": "string", - "filePath": "string" - }, - "filters": [ - { - "protocol": "string", - "localIPAddress": "string", - "remoteIPAddress": "string", - "localPort": "string", - "remotePort": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers/packetCaptures object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers/packetCaptures | -| apiVersion | enum | Yes | 2016-12-01 | -| properties | object | Yes | [PacketCaptureParameters object](#PacketCaptureParameters) | - - - -### PacketCaptureParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| target | string | Yes | The ID of the targeted resource, only VM is currently supported. | -| bytesToCapturePerPacket | integer | No | Number of bytes captured per packet, the remaining bytes are truncated. | -| totalBytesPerSession | integer | No | Maximum size of the capture output. | -| timeLimitInSeconds | integer | No | Maximum duration of the capture session in seconds. | -| storageLocation | object | Yes | [PacketCaptureStorageLocation object](#PacketCaptureStorageLocation) | -| filters | array | No | [PacketCaptureFilter object](#PacketCaptureFilter) | - - - -### PacketCaptureStorageLocation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageId | string | No | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | -| storagePath | string | No | 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. | -| filePath | string | No | 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. | - - - -### PacketCaptureFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol to be filtered on. - TCP, UDP, Any | -| localIPAddress | string | No | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | -| remoteIPAddress | string | No | 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 | No | 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. | -| remotePort | string | No | 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. | - diff --git a/test/Resource/Expected/Network/2016-12-01/publicIPAddresses.md b/test/Resource/Expected/Network/2016-12-01/publicIPAddresses.md deleted file mode 100644 index 2f435e8..0000000 --- a/test/Resource/Expected/Network/2016-12-01/publicIPAddresses.md +++ /dev/null @@ -1,69 +0,0 @@ -# Microsoft.Network/publicIPAddresses template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/publicIPAddresses", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/publicIPAddresses object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/publicIPAddresses | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - diff --git a/test/Resource/Expected/Network/2016-12-01/routeFilters.md b/test/Resource/Expected/Network/2016-12-01/routeFilters.md deleted file mode 100644 index 3e7d6ae..0000000 --- a/test/Resource/Expected/Network/2016-12-01/routeFilters.md +++ /dev/null @@ -1,76 +0,0 @@ -# Microsoft.Network/routeFilters template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/routeFilters resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} - } - ] - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | -| resources | array | No | [routeFilterRules](./routeFilters/routeFilterRules.md) | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2016-12-01/routeFilters/routeFilterRules.md b/test/Resource/Expected/Network/2016-12-01/routeFilters/routeFilterRules.md deleted file mode 100644 index 69021ef..0000000 --- a/test/Resource/Expected/Network/2016-12-01/routeFilters/routeFilterRules.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.Network/routeFilters/routeFilterRules template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/routeFilters/routeFilterRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters/routeFilterRules", - "apiVersion": "2016-12-01", - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters/routeFilterRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters/routeFilterRules | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2016-12-01/routeTables.md b/test/Resource/Expected/Network/2016-12-01/routeTables.md deleted file mode 100644 index cdc58aa..0000000 --- a/test/Resource/Expected/Network/2016-12-01/routeTables.md +++ /dev/null @@ -1,80 +0,0 @@ -# Microsoft.Network/routeTables template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/routeTables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [routes](./routeTables/routes.md) | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/routeTables/routes.md b/test/Resource/Expected/Network/2016-12-01/routeTables/routes.md deleted file mode 100644 index a950afd..0000000 --- a/test/Resource/Expected/Network/2016-12-01/routeTables/routes.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Network/routeTables/routes template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/routeTables/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables/routes", - "apiVersion": "2016-12-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables/routes | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/virtualNetworkGateways.md b/test/Resource/Expected/Network/2016-12-01/virtualNetworkGateways.md deleted file mode 100644 index 7ebd84d..0000000 --- a/test/Resource/Expected/Network/2016-12-01/virtualNetworkGateways.md +++ /dev/null @@ -1,207 +0,0 @@ -# Microsoft.Network/virtualNetworkGateways template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/virtualNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworkGateways", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworkGateways | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. - Basic, HighPerformance, Standard, UltraPerformance | -| tier | enum | No | Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. - Basic, HighPerformance, Standard, UltraPerformance | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2016-12-01/virtualNetworks.md b/test/Resource/Expected/Network/2016-12-01/virtualNetworks.md deleted file mode 100644 index 9f01685..0000000 --- a/test/Resource/Expected/Network/2016-12-01/virtualNetworks.md +++ /dev/null @@ -1,339 +0,0 @@ -# Microsoft.Network/virtualNetworks template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/virtualNetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks", - "apiVersion": "2016-12-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "addressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "string" - ] - }, - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "virtualNetworkPeerings": [ - { - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkPropertiesFormat object](#VirtualNetworkPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [virtualNetworkPeerings](./virtualNetworks/virtualNetworkPeerings.md) [subnets](./virtualNetworks/subnets.md) | - - - -### VirtualNetworkPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressSpace | object | No | The AddressSpace that contains an array of IP address ranges that can be used by subnets. - [AddressSpace object](#AddressSpace) | -| dhcpOptions | object | No | The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. - [DhcpOptions object](#DhcpOptions) | -| subnets | array | No | A list of subnets in a Virtual Network. - [Subnet object](#Subnet) | -| virtualNetworkPeerings | array | No | A list of peerings in a Virtual Network. - [VirtualNetworkPeering object](#VirtualNetworkPeering) | -| resourceGuid | string | No | The resourceGuid property of the Virtual Network resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### DhcpOptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | The list of DNS servers IP addresses. - string | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/virtualNetworks/subnets.md b/test/Resource/Expected/Network/2016-12-01/virtualNetworks/subnets.md deleted file mode 100644 index 4c6d0bf..0000000 --- a/test/Resource/Expected/Network/2016-12-01/virtualNetworks/subnets.md +++ /dev/null @@ -1,228 +0,0 @@ -# Microsoft.Network/virtualNetworks/subnets template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/subnets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/subnets", - "apiVersion": "2016-12-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/subnets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/subnets | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2016-12-01/virtualNetworks/virtualNetworkPeerings.md b/test/Resource/Expected/Network/2016-12-01/virtualNetworks/virtualNetworkPeerings.md deleted file mode 100644 index e39b65d..0000000 --- a/test/Resource/Expected/Network/2016-12-01/virtualNetworks/virtualNetworkPeerings.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/virtualNetworks/virtualNetworkPeerings template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/virtualNetworkPeerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings", - "apiVersion": "2016-12-01", - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/virtualNetworkPeerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/virtualNetworkPeerings | -| apiVersion | enum | Yes | 2016-12-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - diff --git a/test/Resource/Expected/Network/2017-03-01/Microsoft.Network.json b/test/Resource/Expected/Network/2017-03-01/Microsoft.Network.json deleted file mode 100644 index 3d4daf3..0000000 --- a/test/Resource/Expected/Network/2017-03-01/Microsoft.Network.json +++ /dev/null @@ -1,6428 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-03-01/Microsoft.Network.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Network", - "description": "Microsoft Network Resource Types", - "resourceDefinitions": { - "applicationGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationGateways" - }, - "connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/connections" - }, - "expressRouteCircuits": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/expressRouteCircuits_authorizations_childResource" - }, - { - "$ref": "#/definitions/expressRouteCircuits_peerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits" - }, - "expressRouteCircuits_authorizations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "loadBalancers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers" - }, - "localNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/localNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/localNetworkGateways" - }, - "networkInterfaces": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkInterfaces" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkInterfaces" - }, - "networkSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkSecurityGroups_securityRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups" - }, - "networkSecurityGroups_securityRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups/securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "networkWatchers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkWatcherPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkWatchers_packetCaptures_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers" - }, - "networkWatchers_packetCaptures": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers/packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "publicIPAddresses": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/publicIPAddresses" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/publicIPAddresses" - }, - "routeFilters": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeFilters_routeFilterRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters" - }, - "routeFilters_routeFilterRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters/routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "routeTables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeTables_routes_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables" - }, - "routeTables_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "virtualNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworkGateways" - }, - "virtualNetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualNetworks_subnets_childResource" - }, - { - "$ref": "#/definitions/virtualNetworks_virtualNetworkPeerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks" - }, - "virtualNetworks_subnets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - } - }, - "definitions": { - "AddressSpace": { - "type": "object", - "properties": { - "addressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of address blocks reserved for this virtual network in CIDR notation." - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." - }, - "ApplicationGatewayAuthenticationCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Authentication certificates of an application gateway." - }, - "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Certificate public data." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Authentication certificates properties of an application gateway." - }, - "ApplicationGatewayBackendAddress": { - "type": "object", - "properties": { - "fqdn": { - "type": "string", - "description": "Fully qualified domain name (FQDN)." - }, - "ipAddress": { - "type": "string", - "description": "IP address" - } - }, - "description": "Backend address of an application gateway." - }, - "ApplicationGatewayBackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of references to IPs defined in network interfaces." - }, - "backendAddresses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddress" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend addresses" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendHttpSettings": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Backend address pool settings of an application gateway." - }, - "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Port" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "cookieBasedAffinity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cookie based affinity." - }, - "requestTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probe resource of an application gateway." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of references to application gateway authentication certificates." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "connectionDraining": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayConnectionDraining" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connection draining of the backend http settings resource." - } - }, - "description": "Properties of Backend address pool settings of an application gateway." - }, - "ApplicationGatewayConnectionDraining": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether connection draining is enabled or not." - }, - "drainTimeoutInSec": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 3600 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." - } - }, - "required": [ - "enabled", - "drainTimeoutInSec" - ], - "description": "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." - }, - "ApplicationGatewayFirewallDisabledRuleGroup": { - "type": "object", - "properties": { - "ruleGroupName": { - "type": "string", - "description": "The name of the rule group that will be disabled." - }, - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." - } - }, - "required": [ - "ruleGroupName" - ], - "description": "Allows to disable rules within a rule group or an entire rule group." - }, - "ApplicationGatewayFrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "PrivateIPAddress of the network interface IP Configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PrivateIP allocation method." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the PublicIP resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendPort": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Frontend port of an application gateway." - }, - "ApplicationGatewayFrontendPortPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend port of an application gateway." - }, - "ApplicationGatewayHttpListener": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Http listener of an application gateway." - }, - "ApplicationGatewayHttpListenerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP configuration resource of an application gateway." - }, - "frontendPort": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of an application gateway." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "hostName": { - "type": "string", - "description": "Host name of HTTP listener." - }, - "sslCertificate": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificate resource of an application gateway." - }, - "requireServerNameIndication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of HTTP listener of an application gateway." - }, - "ApplicationGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." - }, - "ApplicationGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration of an application gateway." - }, - "ApplicationGatewayPathRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Path rule of URL path map of an application gateway." - }, - "ApplicationGatewayPathRulePropertiesFormat": { - "type": "object", - "properties": { - "paths": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules of URL path map." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of URL path map." - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings resource of URL path map." - }, - "provisioningState": { - "type": "string", - "description": "Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayProbe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Probe of the application gateway." - }, - "ApplicationGatewayProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "host": { - "type": "string", - "description": "Host name to send the probe to." - }, - "path": { - "type": "string", - "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:" - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." - }, - "timeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayPropertiesFormat": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU of the application gateway resource." - }, - "sslPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL policy of the application gateway resource." - }, - "gatewayIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnets of application the gateway resource." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Authentication certificates of the application gateway resource." - }, - "sslCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewaySslCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificates of the application gateway resource." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP addresses of the application gateway resource." - }, - "frontendPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendPort" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend ports of the application gateway resource." - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayProbe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probes of the application gateway resource." - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool of the application gateway resource." - }, - "backendHttpSettingsCollection": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings of the application gateway resource." - }, - "httpListeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayHttpListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listeners of the application gateway resource." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayUrlPathMap" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map of the application gateway resource." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing rules of the application gateway resource." - }, - "webApplicationFirewallConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall configuration." - }, - "resourceGuid": { - "type": "string", - "description": "Resource GUID property of the application gateway resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the application gateway." - }, - "ApplicationGatewayRequestRoutingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Request routing rule of an application gateway." - }, - "ApplicationGatewayRequestRoutingRulePropertiesFormat": { - "type": "object", - "properties": { - "ruleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "PathBasedRouting" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Rule type." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of the application gateway. " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of the application gateway." - }, - "httpListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listener resource of the application gateway. " - }, - "urlPathMap": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map resource of the application gateway." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of request routing rule of the application gateway." - }, - "ApplicationGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_Small", - "Standard_Medium", - "Standard_Large", - "WAF_Medium", - "WAF_Large" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of an application gateway SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "WAF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tier of an application gateway." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity (instance count) of an application gateway." - } - }, - "description": "SKU of an application gateway" - }, - "ApplicationGatewaySslCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "SSL certificates of an application gateway." - }, - "ApplicationGatewaySslCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." - }, - "password": { - "type": "string", - "description": "Password for the pfx file specified in data. Only applicable in PUT request." - }, - "publicCertData": { - "type": "string", - "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of SSL certificates of an application gateway." - }, - "ApplicationGatewaySslPolicy": { - "type": "object", - "properties": { - "disabledSslProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL protocols to be disabled on application gateway." - } - }, - "description": "Application gateway SSL policy." - }, - "ApplicationGatewayUrlPathMap": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." - }, - "ApplicationGatewayUrlPathMapPropertiesFormat": { - "type": "object", - "properties": { - "defaultBackendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend address pool resource of URL path map." - }, - "defaultBackendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend http settings resource of URL path map." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayPathRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rule of URL path map resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of UrlPathMap of the application gateway." - }, - "ApplicationGatewayWebApplicationFirewallConfiguration": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the web application firewall is enabled or not." - }, - "firewallMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Detection", - "Prevention" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall mode." - }, - "ruleSetType": { - "type": "string", - "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." - }, - "ruleSetVersion": { - "type": "string", - "description": "The version of the rule set type." - }, - "disabledRuleGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The disabled rule groups." - } - }, - "required": [ - "enabled", - "firewallMode", - "ruleSetType", - "ruleSetVersion" - ], - "description": "Application gateway web application firewall configuration." - }, - "AuthorizationPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorization key." - }, - "authorizationUseStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Available", - "InUse" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "BackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Pool of backend IP addresses." - }, - "BackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "description": "Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the backend address pool." - }, - "BgpSettings": { - "type": "object", - "properties": { - "asn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BGP speaker's ASN." - }, - "bgpPeeringAddress": { - "type": "string", - "description": "The BGP peering address and BGP identifier of this BGP speaker." - }, - "peerWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The weight added to routes learned from this BGP speaker." - } - }, - "description": "BGP settings details" - }, - "DhcpOptions": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of DNS servers IP addresses." - } - }, - "description": "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." - }, - "ExpressRouteCircuitAuthorization": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Authorization in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Peering in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "advertisedPublicPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of AdvertisedPublicPrefixes." - }, - "advertisedPublicPrefixesState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotConfigured", - "Configuring", - "Configured", - "ValidationNeeded" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'." - }, - "customerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CustomerASN of the peering." - }, - "routingRegistryName": { - "type": "string", - "description": "The RoutingRegistryName of the configuration." - } - }, - "description": "Specifies the peering configuration." - }, - "ExpressRouteCircuitPeeringPropertiesFormat": { - "type": "object", - "properties": { - "peeringType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzurePublicPeering", - "AzurePrivatePeering", - "MicrosoftPeering" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - }, - "azureASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Azure ASN." - }, - "peerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The peer ASN." - }, - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "primaryAzurePort": { - "type": "string", - "description": "The primary port." - }, - "secondaryAzurePort": { - "type": "string", - "description": "The secondary port." - }, - "sharedKey": { - "type": "string", - "description": "The shared key." - }, - "vlanId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The VLAN ID." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "stats": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitStats" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets peering stats." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets whether the provider or the customer last modified the peering." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "ipv6PeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPv6 peering configuration." - } - } - }, - "ExpressRouteCircuitPropertiesFormat": { - "type": "object", - "properties": { - "allowClassicOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allow classic operations" - }, - "circuitProvisioningState": { - "type": "string", - "description": "The CircuitProvisioningState state of the resource." - }, - "serviceProviderProvisioningState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotProvisioned", - "Provisioning", - "Provisioned", - "Deprovisioning" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'." - }, - "authorizations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitAuthorization" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of authorizations." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of peerings." - }, - "serviceKey": { - "type": "string", - "description": "The ServiceKey." - }, - "serviceProviderNotes": { - "type": "string", - "description": "The ServiceProviderNotes." - }, - "serviceProviderProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProperties." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - } - }, - "description": "Properties of ExpressRouteCircuit." - }, - "ExpressRouteCircuitServiceProviderProperties": { - "type": "object", - "properties": { - "serviceProviderName": { - "type": "string", - "description": "The serviceProviderName." - }, - "peeringLocation": { - "type": "string", - "description": "The peering location." - }, - "bandwidthInMbps": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BandwidthInMbps." - } - }, - "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tier of the SKU. Possible values are 'Standard' and 'Premium'." - }, - "family": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UnlimitedData", - "MeteredData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'." - } - }, - "description": "Contains SKU in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitStats": { - "type": "object", - "properties": { - "primarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "primarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - }, - "secondarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "secondarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - } - }, - "description": "Contains stats associated with the peering." - }, - "expressRouteCircuits_authorizations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "FrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Frontend IP address of the load balancer." - }, - "FrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "The private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the Public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP Configuration of the load balancer." - }, - "InboundNatPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT pool of the load balancer." - }, - "InboundNatPoolPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPortRangeStart", - "frontendPortRangeEnd", - "backendPort" - ], - "description": "Properties of Inbound NAT pool." - }, - "InboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT rule of the load balancer." - }, - "InboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the inbound NAT rule." - }, - "IpsecPolicy": { - "type": "object", - "properties": { - "saLifeTimeSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." - }, - "saDataSizeKilobytes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." - }, - "ipsecEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DES", - "DES3", - "AES128", - "AES192", - "AES256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec encryption algorithm (IKE phase 1)." - }, - "ipsecIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec integrity algorithm (IKE phase 1)." - }, - "ikeEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "DES", - "DES3", - "AES128", - "AES192", - "AES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE encryption algorithm (IKE phase 2)." - }, - "ikeIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "SHA384" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE integrity algorithm (IKE phase 2)." - }, - "dhGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DHGroup1", - "DHGroup2", - "DHGroup14", - "DHGroup2048", - "ECP256", - "ECP384", - "DHGroup24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 1 for initial SA." - }, - "pfsGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "PFS1", - "PFS2", - "PFS2048", - "ECP256", - "ECP384", - "PFS24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 2 for new child SA." - } - }, - "required": [ - "saLifeTimeSeconds", - "saDataSizeKilobytes", - "ipsecEncryption", - "ipsecIntegrity", - "ikeEncryption", - "ikeIntegrity", - "dhGroup", - "pfsGroup" - ], - "description": "An IPSec Policy configuration for a virtual network gateway connection" - }, - "Ipv6ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - } - }, - "description": "Contains IPv6 peering config." - }, - "LoadBalancerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/FrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object representing the frontend IPs to be used for the load balancer" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of backend address pools used by a load balancer" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object collection representing the load balancing rules Gets the provisioning " - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Probe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of probe objects used in the load balancer" - }, - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/OutboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The outbound NAT rules." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the load balancer resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the load balancer." - }, - "LoadBalancingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancing rule for a load balancer." - }, - "LoadBalancingRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the load balancer probe used by the load balancing rule." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'." - }, - "loadDistribution": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "SourceIP", - "SourceIPProtocol" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. " - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPort" - ], - "description": "Properties of the load balancer." - }, - "LocalNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "LocalNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "localNetworkAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network site address space." - }, - "gatewayIpAddress": { - "type": "string", - "description": "IP address of local network gateway." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the LocalNetworkGateway resource." - } - }, - "description": "LocalNetworkGateway properties" - }, - "NetworkInterfaceDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "appliedDnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "internalDnsNameLabel": { - "type": "string", - "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." - }, - "internalFqdn": { - "type": "string", - "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." - }, - "internalDomainNameSuffix": { - "type": "string", - "description": "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." - } - }, - "description": "DNS settings of a network interface." - }, - "NetworkInterfaceIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IPConfiguration in a network interface." - }, - "NetworkInterfaceIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of ApplicationGatewayBackendAddressPool resource." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of LoadBalancerBackendAddressPool resource." - }, - "loadBalancerInboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references of LoadBalancerInboundNatRules." - }, - "privateIPAddress": { - "type": "string" - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary customer address on the network interface." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "provisioningState": { - "type": "string" - } - }, - "description": "Properties of IP configuration." - }, - "NetworkInterfacePropertiesFormat": { - "type": "object", - "properties": { - "virtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of a virtual machine." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of IPConfigurations of the network interface." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DNS settings in network interface." - }, - "macAddress": { - "type": "string", - "description": "The MAC address of the network interface." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary network interface on a virtual machine." - }, - "enableAcceleratedNetworking": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the network interface is accelerated networking enabled." - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether IP forwarding is enabled on this network interface." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network interface resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "NetworkInterface properties. " - }, - "NetworkSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "NetworkSecurityGroup resource." - }, - "NetworkSecurityGroupPropertiesFormat": { - "type": "object", - "properties": { - "securityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of security rules of the network security group." - }, - "defaultSecurityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The default security rules of network security group." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network security group resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Network Security Group resource." - }, - "networkSecurityGroups_securityRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "NetworkWatcherPropertiesFormat": { - "type": "object", - "properties": {}, - "description": "The network watcher properties." - }, - "networkWatchers_packetCaptures_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "OutboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OutboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Outbound NAT pool of the load balancer." - }, - "OutboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "allocatedOutboundPorts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of outbound ports to be used for NAT." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Frontend IP addresses of the load balancer." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "backendAddressPool" - ], - "description": "Outbound NAT pool of the load balancer." - }, - "PacketCaptureFilter": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TCP", - "UDP", - "Any" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol to be filtered on." - }, - "localIPAddress": { - "type": "string", - "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." - }, - "remoteIPAddress": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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." - }, - "remotePort": { - "type": "string", - "description": "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." - } - }, - "description": "Filter that is applied to packet capture request. Multiple filters can be applied." - }, - "PacketCaptureParameters": { - "type": "object", - "properties": { - "target": { - "type": "string", - "description": "The ID of the targeted resource, only VM is currently supported." - }, - "bytesToCapturePerPacket": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of bytes captured per packet, the remaining bytes are truncated." - }, - "totalBytesPerSession": { - "oneOf": [ - { - "type": "integer", - "default": "1073741824" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum size of the capture output." - }, - "timeLimitInSeconds": { - "oneOf": [ - { - "type": "integer", - "default": "18000" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum duration of the capture session in seconds." - }, - "storageLocation": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureStorageLocation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "filters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PacketCaptureFilter" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "target", - "storageLocation" - ], - "description": "Parameters that define the create packet capture operation." - }, - "PacketCaptureStorageLocation": { - "type": "object", - "properties": { - "storageId": { - "type": "string", - "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." - }, - "storagePath": { - "type": "string", - "description": "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." - }, - "filePath": { - "type": "string", - "description": "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." - } - }, - "description": "Describes the storage location for a packet capture session." - }, - "Probe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancer probe." - }, - "ProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." - }, - "intervalInSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "numberOfProbes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "requestPath": { - "type": "string", - "description": "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." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "port" - ] - }, - "PublicIPAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Public IP address resource." - }, - "PublicIPAddressDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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. " - } - }, - "description": "Contains FQDN of the DNS record associated with the public IP address" - }, - "PublicIPAddressPropertiesFormat": { - "type": "object", - "properties": { - "publicIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "publicIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The FQDN of the DNS record associated with the public IP address." - }, - "ipAddress": { - "type": "string" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The idle timeout of the public IP address." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Public IP address properties." - }, - "ResourceNavigationLink": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceNavigationLinkFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "ResourceNavigationLink resource." - }, - "ResourceNavigationLinkFormat": { - "type": "object", - "properties": { - "linkedResourceType": { - "type": "string", - "description": "Resource type of the linked resource." - }, - "link": { - "type": "string", - "description": "Link to the external resource" - } - }, - "description": "Properties of ResourceNavigationLink." - }, - "Route": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route resource" - }, - "RouteFilter": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Route Filter Resource." - }, - "RouteFilterPropertiesFormat": { - "type": "object", - "properties": { - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RouteFilterRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of RouteFilterRules contained within a route filter." - } - }, - "description": "Route Filter Resource" - }, - "RouteFilterRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "description": "Route Filter Rule Resource" - }, - "RouteFilterRulePropertiesFormat": { - "type": "object", - "properties": { - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The access type of the rule. Valid values are: 'Allow', 'Deny'." - }, - "routeFilterRuleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Community" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The rule type of the rule. Valid value is: 'Community'" - }, - "communities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']" - } - }, - "required": [ - "access", - "routeFilterRuleType", - "communities" - ], - "description": "Route Filter Rule Resource" - }, - "routeFilters_routeFilterRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "RoutePropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The destination CIDR to which the route applies." - }, - "nextHopType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VirtualNetworkGateway", - "VnetLocal", - "Internet", - "VirtualAppliance", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'." - }, - "nextHopIpAddress": { - "type": "string", - "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "nextHopType" - ], - "description": "Route resource" - }, - "RouteTable": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route table resource." - }, - "RouteTablePropertiesFormat": { - "type": "object", - "properties": { - "routes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Route" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of routes contained within a route table." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Route Table resource" - }, - "routeTables_routes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "SecurityRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Network security rule." - }, - "SecurityRulePropertiesFormat": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description for this rule. Restricted to 140 chars." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp", - "*" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'." - }, - "sourcePortRange": { - "type": "string", - "description": "The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "destinationPortRange": { - "type": "string", - "description": "The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "sourceAddressPrefix": { - "type": "string", - "description": "The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " - }, - "destinationAddressPrefix": { - "type": "string", - "description": "The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'." - }, - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "sourceAddressPrefix", - "destinationAddressPrefix", - "access", - "direction" - ] - }, - "Subnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Subnet in a virtual network resource." - }, - "SubnetPropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The address prefix for the subnet." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "routeTable": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTable" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteTable resource." - }, - "resourceNavigationLinks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceNavigationLink" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets an array of references to the external resources using subnet." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - } - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - } - } - }, - "VirtualNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "VirtualNetworkGatewayConnectionPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorizationKey." - }, - "virtualNetworkGateway1": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "virtualNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "localNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "connectionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPsec", - "Vnet2Vnet", - "ExpressRoute", - "VPNClient" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient." - }, - "routingWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The routing weight." - }, - "sharedKey": { - "type": "string", - "description": "The IPSec shared key." - }, - "peer": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to peerings resource." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp flag" - }, - "usePolicyBasedTrafficSelectors": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Enable policy-based traffic selectors." - }, - "ipsecPolicies": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IpsecPolicy" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Policies to be considered by this connection." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." - } - }, - "required": [ - "virtualNetworkGateway1", - "connectionType" - ], - "description": "VirtualNetworkGatewayConnection properties" - }, - "VirtualNetworkGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration for virtual network gateway" - }, - "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the public IP resource." - } - }, - "description": "Properties of VirtualNetworkGatewayIPConfiguration" - }, - "VirtualNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IP configurations for virtual network gateway." - }, - "gatewayType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Vpn", - "ExpressRoute" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PolicyBased", - "RouteBased" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether BGP is enabled for this virtual network gateway or not." - }, - "activeActive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "ActiveActive flag" - }, - "gatewayDefaultSite": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." - }, - "vpnClientConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGateway resource." - } - }, - "description": "VirtualNetworkGateway properties" - }, - "VirtualNetworkGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU name." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU tier." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity." - } - }, - "description": "VirtualNetworkGatewaySku details" - }, - "VirtualNetworkPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Peerings in a virtual network resource." - }, - "VirtualNetworkPeeringPropertiesFormat": { - "type": "object", - "properties": { - "allowVirtualNetworkAccess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space." - }, - "allowForwardedTraffic": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed." - }, - "allowGatewayTransit": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If gateway links can be used in remote virtual networking to link to this virtual network." - }, - "useRemoteGateways": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "remoteVirtualNetwork": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the remote virtual network." - }, - "peeringState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Initiated", - "Connected", - "Disconnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - } - }, - "VirtualNetworkPropertiesFormat": { - "type": "object", - "properties": { - "addressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." - }, - "dhcpOptions": { - "oneOf": [ - { - "$ref": "#/definitions/DhcpOptions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of subnets in a Virtual Network." - }, - "virtualNetworkPeerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of peerings in a Virtual Network." - }, - "resourceGuid": { - "type": "string", - "description": "The resourceGuid property of the Virtual Network resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "virtualNetworks_subnets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - }, - "VpnClientConfiguration": { - "type": "object", - "properties": { - "vpnClientAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the address space resource which represents Address space for P2S VpnClient." - }, - "vpnClientRootCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRootCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRootCertificate for virtual network gateway." - }, - "vpnClientRevokedCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRevokedCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRevokedCertificate for Virtual network gateway." - } - }, - "description": "VpnClientConfiguration for P2S client." - }, - "VpnClientRevokedCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "VPN client revoked certificate of virtual network gateway." - }, - "VpnClientRevokedCertificatePropertiesFormat": { - "type": "object", - "properties": { - "thumbprint": { - "type": "string", - "description": "The revoked VPN client certificate thumbprint." - } - }, - "description": "Properties of the revoked VPN client certificate of virtual network gateway." - }, - "VpnClientRootCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "VPN client root certificate of virtual network gateway" - }, - "VpnClientRootCertificatePropertiesFormat": { - "type": "object", - "properties": { - "publicCertData": { - "type": "string", - "description": "The certificate public data." - } - }, - "required": [ - "publicCertData" - ], - "description": "Properties of SSL certificates of application gateway" - } - } -} diff --git a/test/Resource/Expected/Network/2017-03-01/applicationGateways.md b/test/Resource/Expected/Network/2017-03-01/applicationGateways.md deleted file mode 100644 index 86ad2ae..0000000 --- a/test/Resource/Expected/Network/2017-03-01/applicationGateways.md +++ /dev/null @@ -1,968 +0,0 @@ -# Microsoft.Network/applicationGateways template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/applicationGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationGateways", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "sslPolicy": { - "disabledSslProtocols": [ - "string" - ] - }, - "gatewayIPConfigurations": [ - { - "id": "string", - "properties": { - "subnet": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "authenticationCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "sslCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "password": "string", - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "frontendPorts": [ - { - "id": "string", - "properties": { - "port": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "host": "string", - "path": "string", - "interval": "integer", - "timeout": "integer", - "unhealthyThreshold": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - "ApplicationGatewayBackendAddressPool" - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendHttpSettingsCollection": [ - { - "id": "string", - "properties": { - "port": "integer", - "protocol": "string", - "cookieBasedAffinity": "string", - "requestTimeout": "integer", - "probe": { - "id": "string" - }, - "authenticationCertificates": [ - { - "id": "string" - } - ], - "provisioningState": "string", - "connectionDraining": { - "enabled": "boolean", - "drainTimeoutInSec": "integer" - } - }, - "name": "string", - "etag": "string" - } - ], - "httpListeners": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "frontendPort": { - "id": "string" - }, - "protocol": "string", - "hostName": "string", - "sslCertificate": { - "id": "string" - }, - "requireServerNameIndication": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "urlPathMaps": [ - { - "id": "string", - "properties": { - "defaultBackendAddressPool": { - "id": "string" - }, - "defaultBackendHttpSettings": { - "id": "string" - }, - "pathRules": [ - { - "id": "string", - "properties": { - "paths": [ - "string" - ], - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "requestRoutingRules": [ - { - "id": "string", - "properties": { - "ruleType": "string", - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "httpListener": { - "id": "string" - }, - "urlPathMap": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "webApplicationFirewallConfiguration": { - "enabled": "boolean", - "firewallMode": "string", - "ruleSetType": "string", - "ruleSetVersion": "string", - "disabledRuleGroups": [ - { - "ruleGroupName": "string", - "rules": [ - "integer" - ] - } - ] - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationGateways | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [ApplicationGatewayPropertiesFormat object](#ApplicationGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | SKU of the application gateway resource. - [ApplicationGatewaySku object](#ApplicationGatewaySku) | -| sslPolicy | object | No | SSL policy of the application gateway resource. - [ApplicationGatewaySslPolicy object](#ApplicationGatewaySslPolicy) | -| gatewayIPConfigurations | array | No | Subnets of application the gateway resource. - [ApplicationGatewayIPConfiguration object](#ApplicationGatewayIPConfiguration) | -| authenticationCertificates | array | No | Authentication certificates of the application gateway resource. - [ApplicationGatewayAuthenticationCertificate object](#ApplicationGatewayAuthenticationCertificate) | -| sslCertificates | array | No | SSL certificates of the application gateway resource. - [ApplicationGatewaySslCertificate object](#ApplicationGatewaySslCertificate) | -| frontendIPConfigurations | array | No | Frontend IP addresses of the application gateway resource. - [ApplicationGatewayFrontendIPConfiguration object](#ApplicationGatewayFrontendIPConfiguration) | -| frontendPorts | array | No | Frontend ports of the application gateway resource. - [ApplicationGatewayFrontendPort object](#ApplicationGatewayFrontendPort) | -| probes | array | No | Probes of the application gateway resource. - [ApplicationGatewayProbe object](#ApplicationGatewayProbe) | -| backendAddressPools | array | No | Backend address pool of the application gateway resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| backendHttpSettingsCollection | array | No | Backend http settings of the application gateway resource. - [ApplicationGatewayBackendHttpSettings object](#ApplicationGatewayBackendHttpSettings) | -| httpListeners | array | No | Http listeners of the application gateway resource. - [ApplicationGatewayHttpListener object](#ApplicationGatewayHttpListener) | -| urlPathMaps | array | No | URL path map of the application gateway resource. - [ApplicationGatewayUrlPathMap object](#ApplicationGatewayUrlPathMap) | -| requestRoutingRules | array | No | Request routing rules of the application gateway resource. - [ApplicationGatewayRequestRoutingRule object](#ApplicationGatewayRequestRoutingRule) | -| webApplicationFirewallConfiguration | object | No | Web application firewall configuration. - [ApplicationGatewayWebApplicationFirewallConfiguration object](#ApplicationGatewayWebApplicationFirewallConfiguration) | -| resourceGuid | string | No | Resource GUID property of the application gateway resource. | -| provisioningState | string | No | Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of an application gateway SKU. - Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large | -| tier | enum | No | Tier of an application gateway. - Standard or WAF | -| capacity | integer | No | Capacity (instance count) of an application gateway. | - - - -### ApplicationGatewaySslPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disabledSslProtocols | array | No | SSL protocols to be disabled on application gateway. - TLSv1_0, TLSv1_1, TLSv1_2 | - - - -### ApplicationGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayIPConfigurationPropertiesFormat object](#ApplicationGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayAuthenticationCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayAuthenticationCertificatePropertiesFormat object](#ApplicationGatewayAuthenticationCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewaySslCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewaySslCertificatePropertiesFormat object](#ApplicationGatewaySslCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayFrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendIPConfigurationPropertiesFormat object](#ApplicationGatewayFrontendIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayFrontendPort object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendPortPropertiesFormat object](#ApplicationGatewayFrontendPortPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayProbe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayProbePropertiesFormat object](#ApplicationGatewayProbePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendHttpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendHttpSettingsPropertiesFormat object](#ApplicationGatewayBackendHttpSettingsPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayHttpListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayHttpListenerPropertiesFormat object](#ApplicationGatewayHttpListenerPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayUrlPathMap object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayUrlPathMapPropertiesFormat object](#ApplicationGatewayUrlPathMapPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayRequestRoutingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRequestRoutingRulePropertiesFormat object](#ApplicationGatewayRequestRoutingRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayWebApplicationFirewallConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether the web application firewall is enabled or not. | -| firewallMode | enum | Yes | Web application firewall mode. - Detection or Prevention | -| ruleSetType | string | Yes | The type of the web application firewall rule set. Possible values are: 'OWASP'. | -| ruleSetVersion | string | Yes | The version of the rule set type. | -| disabledRuleGroups | array | No | The disabled rule groups. - [ApplicationGatewayFirewallDisabledRuleGroup object](#ApplicationGatewayFirewallDisabledRuleGroup) | - - - -### ApplicationGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Reference of the subnet resource. A subnet from where application gateway gets its private address. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayAuthenticationCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Certificate public data. | -| provisioningState | string | No | Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySslCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Base-64 encoded pfx certificate. Only applicable in PUT Request. | -| password | string | No | Password for the pfx file specified in data. Only applicable in PUT request. | -| publicCertData | string | No | Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. | -| provisioningState | string | No | Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | PrivateIPAddress of the network interface IP Configuration. | -| privateIPAllocationMethod | enum | No | PrivateIP allocation method. - Static or Dynamic | -| subnet | object | No | Reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Reference of the PublicIP resource. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendPortPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Frontend port | -| provisioningState | string | No | Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol. - Http or Https | -| host | string | No | Host name to send the probe to. | -| path | string | No | Relative path of probe. Valid path starts from '/'. Probe is sent to ://: | -| interval | integer | No | The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. | -| timeout | integer | No | 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 | integer | No | 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 | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendHttpSettingsPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Port | -| protocol | enum | No | Protocol. - Http or Https | -| cookieBasedAffinity | enum | No | Cookie based affinity. - Enabled or Disabled | -| requestTimeout | integer | No | 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. | -| probe | object | No | Probe resource of an application gateway. - [SubResource object](#SubResource) | -| authenticationCertificates | array | No | Array of references to application gateway authentication certificates. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| connectionDraining | object | No | Connection draining of the backend http settings resource. - [ApplicationGatewayConnectionDraining object](#ApplicationGatewayConnectionDraining) | - - - -### ApplicationGatewayHttpListenerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Frontend IP configuration resource of an application gateway. - [SubResource object](#SubResource) | -| frontendPort | object | No | Frontend port resource of an application gateway. - [SubResource object](#SubResource) | -| protocol | enum | No | Protocol. - Http or Https | -| hostName | string | No | Host name of HTTP listener. | -| sslCertificate | object | No | SSL certificate resource of an application gateway. - [SubResource object](#SubResource) | -| requireServerNameIndication | boolean | No | Applicable only if protocol is https. Enables SNI for multi-hosting. | -| provisioningState | string | No | Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayUrlPathMapPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultBackendAddressPool | object | No | Default backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| defaultBackendHttpSettings | object | No | Default backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rule of URL path map resource. - [ApplicationGatewayPathRule object](#ApplicationGatewayPathRule) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRequestRoutingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleType | enum | No | Rule type. - Basic or PathBasedRouting | -| backendAddressPool | object | No | Backend address pool resource of the application gateway. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Frontend port resource of the application gateway. - [SubResource object](#SubResource) | -| httpListener | object | No | Http listener resource of the application gateway. - [SubResource object](#SubResource) | -| urlPathMap | object | No | URL path map resource of the application gateway. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFirewallDisabledRuleGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleGroupName | string | Yes | The name of the rule group that will be disabled. | -| rules | array | No | The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - integer | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### ApplicationGatewayConnectionDraining object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether connection draining is enabled or not. | -| drainTimeoutInSec | integer | Yes | The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. | - - - -### ApplicationGatewayPathRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayPathRulePropertiesFormat object](#ApplicationGatewayPathRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### ApplicationGatewayPathRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| paths | array | No | Path rules of URL path map. - string | -| backendAddressPool | object | No | Backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| provisioningState | string | No | Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/connections.md b/test/Resource/Expected/Network/2017-03-01/connections.md deleted file mode 100644 index 9625021..0000000 --- a/test/Resource/Expected/Network/2017-03-01/connections.md +++ /dev/null @@ -1,390 +0,0 @@ -# Microsoft.Network/connections template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/connections", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "authorizationKey": "string", - "virtualNetworkGateway1": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "virtualNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "localNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "connectionType": "string", - "routingWeight": "integer", - "sharedKey": "string", - "peer": { - "id": "string" - }, - "enableBgp": "boolean", - "usePolicyBasedTrafficSelectors": "boolean", - "ipsecPolicies": [ - { - "saLifeTimeSeconds": "integer", - "saDataSizeKilobytes": "integer", - "ipsecEncryption": "string", - "ipsecIntegrity": "string", - "ikeEncryption": "string", - "ikeIntegrity": "string", - "dhGroup": "string", - "pfsGroup": "string" - } - ], - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/connections | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkGatewayConnectionPropertiesFormat object](#VirtualNetworkGatewayConnectionPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayConnectionPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorizationKey. | -| virtualNetworkGateway1 | object | Yes | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| virtualNetworkGateway2 | object | No | [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| localNetworkGateway2 | object | No | [LocalNetworkGateway object](#LocalNetworkGateway) | -| connectionType | enum | Yes | Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. - IPsec, Vnet2Vnet, ExpressRoute, VPNClient | -| routingWeight | integer | No | The routing weight. | -| sharedKey | string | No | The IPSec shared key. | -| peer | object | No | The reference to peerings resource. - [SubResource object](#SubResource) | -| enableBgp | boolean | No | EnableBgp flag | -| usePolicyBasedTrafficSelectors | boolean | No | Enable policy-based traffic selectors. | -| ipsecPolicies | array | No | The IPSec Policies to be considered by this connection. - [IpsecPolicy object](#IpsecPolicy) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGatewayConnection resource. | - - - -### VirtualNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### IpsecPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| saLifeTimeSeconds | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. | -| saDataSizeKilobytes | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. | -| ipsecEncryption | enum | Yes | The IPSec encryption algorithm (IKE phase 1). - None, DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256 | -| ipsecIntegrity | enum | Yes | The IPSec integrity algorithm (IKE phase 1). - MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256 | -| ikeEncryption | enum | Yes | The IKE encryption algorithm (IKE phase 2). - DES, DES3, AES128, AES192, AES256 | -| ikeIntegrity | enum | Yes | The IKE integrity algorithm (IKE phase 2). - MD5, SHA1, SHA256, SHA384 | -| dhGroup | enum | Yes | The DH Groups used in IKE Phase 1 for initial SA. - None, DHGroup1, DHGroup2, DHGroup14, DHGroup2048, ECP256, ECP384, DHGroup24 | -| pfsGroup | enum | Yes | The DH Groups used in IKE Phase 2 for new child SA. - None, PFS1, PFS2, PFS2048, ECP256, ECP384, PFS24 | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-03-01/expressRouteCircuits.md b/test/Resource/Expected/Network/2017-03-01/expressRouteCircuits.md deleted file mode 100644 index baae1dc..0000000 --- a/test/Resource/Expected/Network/2017-03-01/expressRouteCircuits.md +++ /dev/null @@ -1,306 +0,0 @@ -# Microsoft.Network/expressRouteCircuits template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "family": "string" - }, - "properties": { - "allowClassicOperations": "boolean", - "circuitProvisioningState": "string", - "serviceProviderProvisioningState": "string", - "authorizations": [ - { - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "name": "string" - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} - } - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} - } - ] - } - }, - "state": "string" - } - }, - "name": "string" - } - ], - "serviceKey": "string", - "serviceProviderNotes": "string", - "serviceProviderProperties": { - "serviceProviderName": "string", - "peeringLocation": "string", - "bandwidthInMbps": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The SKU. - [ExpressRouteCircuitSku object](#ExpressRouteCircuitSku) | -| properties | object | Yes | [ExpressRouteCircuitPropertiesFormat object](#ExpressRouteCircuitPropertiesFormat) | -| resources | array | No | [peerings](./expressRouteCircuits/peerings.md) [authorizations](./expressRouteCircuits/authorizations.md) | - - - -### ExpressRouteCircuitSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the SKU. | -| tier | enum | No | The tier of the SKU. Possible values are 'Standard' and 'Premium'. - Standard or Premium | -| family | enum | No | The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. - UnlimitedData or MeteredData | - - - -### ExpressRouteCircuitPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowClassicOperations | boolean | No | Allow classic operations | -| circuitProvisioningState | string | No | The CircuitProvisioningState state of the resource. | -| serviceProviderProvisioningState | enum | No | The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - NotProvisioned, Provisioning, Provisioned, Deprovisioning | -| authorizations | array | No | The list of authorizations. - [ExpressRouteCircuitAuthorization object](#ExpressRouteCircuitAuthorization) | -| peerings | array | No | The list of peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | -| serviceKey | string | No | The ServiceKey. | -| serviceProviderNotes | string | No | The ServiceProviderNotes. | -| serviceProviderProperties | object | No | The ServiceProviderProperties. - [ExpressRouteCircuitServiceProviderProperties object](#ExpressRouteCircuitServiceProviderProperties) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | - - - -### ExpressRouteCircuitAuthorization object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitServiceProviderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceProviderName | string | No | The serviceProviderName. | -| peeringLocation | string | No | The peering location. | -| bandwidthInMbps | integer | No | The BandwidthInMbps. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-03-01/expressRouteCircuits/authorizations.md b/test/Resource/Expected/Network/2017-03-01/expressRouteCircuits/authorizations.md deleted file mode 100644 index c04ad0d..0000000 --- a/test/Resource/Expected/Network/2017-03-01/expressRouteCircuits/authorizations.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/authorizations template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/authorizations", - "apiVersion": "2017-03-01", - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/authorizations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/authorizations | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/expressRouteCircuits/peerings.md b/test/Resource/Expected/Network/2017-03-01/expressRouteCircuits/peerings.md deleted file mode 100644 index 3072657..0000000 --- a/test/Resource/Expected/Network/2017-03-01/expressRouteCircuits/peerings.md +++ /dev/null @@ -1,202 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/peerings template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/peerings", - "apiVersion": "2017-03-01", - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} - } - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} - } - ] - } - }, - "state": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/peerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/peerings | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-03-01/loadBalancers.md b/test/Resource/Expected/Network/2017-03-01/loadBalancers.md deleted file mode 100644 index 3fca718..0000000 --- a/test/Resource/Expected/Network/2017-03-01/loadBalancers.md +++ /dev/null @@ -1,592 +0,0 @@ -# Microsoft.Network/loadBalancers template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/loadBalancers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendAddressPool": { - "id": "string" - }, - "probe": { - "id": "string" - }, - "protocol": "string", - "loadDistribution": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "port": "integer", - "intervalInSeconds": "integer", - "numberOfProbes": "integer", - "requestPath": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatPools": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "backendPort": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "outboundNatRules": [ - { - "id": "string", - "properties": { - "allocatedOutboundPorts": "integer", - "frontendIPConfigurations": [ - { - "id": "string" - } - ], - "backendAddressPool": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [LoadBalancerPropertiesFormat object](#LoadBalancerPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfigurations | array | No | Object representing the frontend IPs to be used for the load balancer - [FrontendIPConfiguration object](#FrontendIPConfiguration) | -| backendAddressPools | array | No | Collection of backend address pools used by a load balancer - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancingRules | array | No | Object collection representing the load balancing rules Gets the provisioning - [LoadBalancingRule object](#LoadBalancingRule) | -| probes | array | No | Collection of probe objects used in the load balancer - [Probe object](#Probe) | -| inboundNatRules | array | No | 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. - [InboundNatRule object](#InboundNatRule) | -| inboundNatPools | array | No | 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. - [InboundNatPool object](#InboundNatPool) | -| outboundNatRules | array | No | The outbound NAT rules. - [OutboundNatRule object](#OutboundNatRule) | -| resourceGuid | string | No | The resource GUID property of the load balancer resource. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### FrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [FrontendIPConfigurationPropertiesFormat object](#FrontendIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [LoadBalancingRulePropertiesFormat object](#LoadBalancingRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Probe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ProbePropertiesFormat object](#ProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatPoolPropertiesFormat object](#InboundNatPoolPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### OutboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [OutboundNatRulePropertiesFormat object](#OutboundNatRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### FrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | The private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [Subnet object](#Subnet) | -| publicIPAddress | object | No | The reference of the Public IP resource. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### LoadBalancingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| backendAddressPool | object | No | A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| probe | object | No | The reference of the load balancer probe used by the load balancing rule. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'. - Udp or Tcp | -| loadDistribution | enum | No | The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. - Default, SourceIP, SourceIPProtocol | -| frontendPort | integer | Yes | 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. | -| backendPort | integer | No | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | Yes | 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. - Http or Tcp | -| port | integer | Yes | The port for communicating the probe. Possible values range from 1 to 65535, inclusive. | -| intervalInSeconds | integer | No | 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. | -| numberOfProbes | integer | No | 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. | -| requestPath | string | No | 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. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPortRangeStart | integer | Yes | 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. | -| frontendPortRangeEnd | integer | Yes | 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. | -| backendPort | integer | Yes | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### OutboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allocatedOutboundPorts | integer | No | The number of outbound ports to be used for NAT. | -| frontendIPConfigurations | array | No | The Frontend IP addresses of the load balancer. - [SubResource object](#SubResource) | -| backendAddressPool | object | Yes | A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/localNetworkGateways.md b/test/Resource/Expected/Network/2017-03-01/localNetworkGateways.md deleted file mode 100644 index a28551e..0000000 --- a/test/Resource/Expected/Network/2017-03-01/localNetworkGateways.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/localNetworkGateways template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/localNetworkGateways", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/localNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/localNetworkGateways | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - diff --git a/test/Resource/Expected/Network/2017-03-01/networkInterfaces.md b/test/Resource/Expected/Network/2017-03-01/networkInterfaces.md deleted file mode 100644 index 7141dbe..0000000 --- a/test/Resource/Expected/Network/2017-03-01/networkInterfaces.md +++ /dev/null @@ -1,557 +0,0 @@ -# Microsoft.Network/networkInterfaces template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/networkInterfaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkInterfaces", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableAcceleratedNetworking": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkInterfaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkInterfaces | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | The reference of a virtual machine. - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | A list of IPConfigurations of the network interface. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | The DNS settings in network interface. - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | The MAC address of the network interface. | -| primary | boolean | No | Gets whether this is a primary network interface on a virtual machine. | -| enableAcceleratedNetworking | boolean | No | If the network interface is accelerated networking enabled. | -| enableIPForwarding | boolean | No | Indicates whether IP forwarding is enabled on this network interface. | -| resourceGuid | string | No | The resource GUID property of the network interface resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | 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. - string | -| appliedDnsServers | array | No | 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. - string | -| internalDnsNameLabel | string | No | Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. | -| internalFqdn | string | No | Fully qualified DNS name supporting internal communications between VMs in the same virtual network. | -| internalDomainNameSuffix | string | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/networkSecurityGroups.md b/test/Resource/Expected/Network/2017-03-01/networkSecurityGroups.md deleted file mode 100644 index 8d2b566..0000000 --- a/test/Resource/Expected/Network/2017-03-01/networkSecurityGroups.md +++ /dev/null @@ -1,114 +0,0 @@ -# Microsoft.Network/networkSecurityGroups template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [securityRules](./networkSecurityGroups/securityRules.md) | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/networkSecurityGroups/securityRules.md b/test/Resource/Expected/Network/2017-03-01/networkSecurityGroups/securityRules.md deleted file mode 100644 index 6b82067..0000000 --- a/test/Resource/Expected/Network/2017-03-01/networkSecurityGroups/securityRules.md +++ /dev/null @@ -1,58 +0,0 @@ -# Microsoft.Network/networkSecurityGroups/securityRules template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups/securityRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups/securityRules", - "apiVersion": "2017-03-01", - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups/securityRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups/securityRules | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/networkWatchers.md b/test/Resource/Expected/Network/2017-03-01/networkWatchers.md deleted file mode 100644 index e772c69..0000000 --- a/test/Resource/Expected/Network/2017-03-01/networkWatchers.md +++ /dev/null @@ -1,37 +0,0 @@ -# Microsoft.Network/networkWatchers template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/networkWatchers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "etag": "string", - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| properties | object | Yes | [NetworkWatcherPropertiesFormat object](#NetworkWatcherPropertiesFormat) | -| resources | array | No | [packetCaptures](./networkWatchers/packetCaptures.md) | - diff --git a/test/Resource/Expected/Network/2017-03-01/networkWatchers/packetCaptures.md b/test/Resource/Expected/Network/2017-03-01/networkWatchers/packetCaptures.md deleted file mode 100644 index 6f5e2d2..0000000 --- a/test/Resource/Expected/Network/2017-03-01/networkWatchers/packetCaptures.md +++ /dev/null @@ -1,78 +0,0 @@ -# Microsoft.Network/networkWatchers/packetCaptures template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers/packetCaptures", - "apiVersion": "2017-03-01", - "properties": { - "target": "string", - "bytesToCapturePerPacket": "integer", - "totalBytesPerSession": "integer", - "timeLimitInSeconds": "integer", - "storageLocation": { - "storageId": "string", - "storagePath": "string", - "filePath": "string" - }, - "filters": [ - { - "protocol": "string", - "localIPAddress": "string", - "remoteIPAddress": "string", - "localPort": "string", - "remotePort": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers/packetCaptures object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers/packetCaptures | -| apiVersion | enum | Yes | 2017-03-01 | -| properties | object | Yes | [PacketCaptureParameters object](#PacketCaptureParameters) | - - - -### PacketCaptureParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| target | string | Yes | The ID of the targeted resource, only VM is currently supported. | -| bytesToCapturePerPacket | integer | No | Number of bytes captured per packet, the remaining bytes are truncated. | -| totalBytesPerSession | integer | No | Maximum size of the capture output. | -| timeLimitInSeconds | integer | No | Maximum duration of the capture session in seconds. | -| storageLocation | object | Yes | [PacketCaptureStorageLocation object](#PacketCaptureStorageLocation) | -| filters | array | No | [PacketCaptureFilter object](#PacketCaptureFilter) | - - - -### PacketCaptureStorageLocation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageId | string | No | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | -| storagePath | string | No | 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. | -| filePath | string | No | 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. | - - - -### PacketCaptureFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol to be filtered on. - TCP, UDP, Any | -| localIPAddress | string | No | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | -| remoteIPAddress | string | No | 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 | No | 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. | -| remotePort | string | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-03-01/publicIPAddresses.md b/test/Resource/Expected/Network/2017-03-01/publicIPAddresses.md deleted file mode 100644 index b3ea666..0000000 --- a/test/Resource/Expected/Network/2017-03-01/publicIPAddresses.md +++ /dev/null @@ -1,69 +0,0 @@ -# Microsoft.Network/publicIPAddresses template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/publicIPAddresses", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/publicIPAddresses object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/publicIPAddresses | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-03-01/routeFilters.md b/test/Resource/Expected/Network/2017-03-01/routeFilters.md deleted file mode 100644 index deb701d..0000000 --- a/test/Resource/Expected/Network/2017-03-01/routeFilters.md +++ /dev/null @@ -1,76 +0,0 @@ -# Microsoft.Network/routeFilters template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/routeFilters resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} - } - ] - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | -| resources | array | No | [routeFilterRules](./routeFilters/routeFilterRules.md) | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-03-01/routeFilters/routeFilterRules.md b/test/Resource/Expected/Network/2017-03-01/routeFilters/routeFilterRules.md deleted file mode 100644 index 21bc1fd..0000000 --- a/test/Resource/Expected/Network/2017-03-01/routeFilters/routeFilterRules.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.Network/routeFilters/routeFilterRules template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/routeFilters/routeFilterRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters/routeFilterRules", - "apiVersion": "2017-03-01", - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters/routeFilterRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters/routeFilterRules | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-03-01/routeTables.md b/test/Resource/Expected/Network/2017-03-01/routeTables.md deleted file mode 100644 index 9c6e962..0000000 --- a/test/Resource/Expected/Network/2017-03-01/routeTables.md +++ /dev/null @@ -1,80 +0,0 @@ -# Microsoft.Network/routeTables template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/routeTables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [routes](./routeTables/routes.md) | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/routeTables/routes.md b/test/Resource/Expected/Network/2017-03-01/routeTables/routes.md deleted file mode 100644 index 7619b34..0000000 --- a/test/Resource/Expected/Network/2017-03-01/routeTables/routes.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Network/routeTables/routes template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/routeTables/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables/routes", - "apiVersion": "2017-03-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables/routes | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/virtualNetworkGateways.md b/test/Resource/Expected/Network/2017-03-01/virtualNetworkGateways.md deleted file mode 100644 index e8c2ae4..0000000 --- a/test/Resource/Expected/Network/2017-03-01/virtualNetworkGateways.md +++ /dev/null @@ -1,207 +0,0 @@ -# Microsoft.Network/virtualNetworkGateways template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/virtualNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworkGateways", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ] - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworkGateways | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-03-01/virtualNetworks.md b/test/Resource/Expected/Network/2017-03-01/virtualNetworks.md deleted file mode 100644 index f1d3815..0000000 --- a/test/Resource/Expected/Network/2017-03-01/virtualNetworks.md +++ /dev/null @@ -1,339 +0,0 @@ -# Microsoft.Network/virtualNetworks template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/virtualNetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks", - "apiVersion": "2017-03-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "addressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "string" - ] - }, - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "virtualNetworkPeerings": [ - { - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VirtualNetworkPropertiesFormat object](#VirtualNetworkPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [virtualNetworkPeerings](./virtualNetworks/virtualNetworkPeerings.md) [subnets](./virtualNetworks/subnets.md) | - - - -### VirtualNetworkPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressSpace | object | No | The AddressSpace that contains an array of IP address ranges that can be used by subnets. - [AddressSpace object](#AddressSpace) | -| dhcpOptions | object | No | The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. - [DhcpOptions object](#DhcpOptions) | -| subnets | array | No | A list of subnets in a Virtual Network. - [Subnet object](#Subnet) | -| virtualNetworkPeerings | array | No | A list of peerings in a Virtual Network. - [VirtualNetworkPeering object](#VirtualNetworkPeering) | -| resourceGuid | string | No | The resourceGuid property of the Virtual Network resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### DhcpOptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | The list of DNS servers IP addresses. - string | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/virtualNetworks/subnets.md b/test/Resource/Expected/Network/2017-03-01/virtualNetworks/subnets.md deleted file mode 100644 index b6f584a..0000000 --- a/test/Resource/Expected/Network/2017-03-01/virtualNetworks/subnets.md +++ /dev/null @@ -1,228 +0,0 @@ -# Microsoft.Network/virtualNetworks/subnets template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/subnets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/subnets", - "apiVersion": "2017-03-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "destinationAddressPrefix": "string", - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/subnets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/subnets | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | Yes | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| destinationAddressPrefix | string | Yes | The destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-03-01/virtualNetworks/virtualNetworkPeerings.md b/test/Resource/Expected/Network/2017-03-01/virtualNetworks/virtualNetworkPeerings.md deleted file mode 100644 index e493d79..0000000 --- a/test/Resource/Expected/Network/2017-03-01/virtualNetworks/virtualNetworkPeerings.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/virtualNetworks/virtualNetworkPeerings template reference -API Version: 2017-03-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/virtualNetworkPeerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings", - "apiVersion": "2017-03-01", - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/virtualNetworkPeerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/virtualNetworkPeerings | -| apiVersion | enum | Yes | 2017-03-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - diff --git a/test/Resource/Expected/Network/2017-06-01/Microsoft.Network.json b/test/Resource/Expected/Network/2017-06-01/Microsoft.Network.json deleted file mode 100644 index bf0806a..0000000 --- a/test/Resource/Expected/Network/2017-06-01/Microsoft.Network.json +++ /dev/null @@ -1,7198 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-06-01/Microsoft.Network.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Network", - "description": "Microsoft Network Resource Types", - "resourceDefinitions": { - "applicationGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationGateways" - }, - "connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway connection." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/connections" - }, - "expressRouteCircuits": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/expressRouteCircuits_authorizations_childResource" - }, - { - "$ref": "#/definitions/expressRouteCircuits_peerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits" - }, - "expressRouteCircuits_authorizations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "loadBalancers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/loadBalancers_inboundNatRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers" - }, - "loadBalancers_inboundNatRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers/inboundNatRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers/inboundNatRules" - }, - "localNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/localNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the local network gateway." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/localNetworkGateways" - }, - "networkInterfaces": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkInterfaces" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network interface." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkInterfaces" - }, - "networkSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network security group" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkSecurityGroups_securityRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups" - }, - "networkSecurityGroups_securityRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups/securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "networkWatchers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkWatcherPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkWatchers_packetCaptures_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers" - }, - "networkWatchers_packetCaptures": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers/packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "publicIPAddresses": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/publicIPAddresses" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address properties." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/publicIPAddresses" - }, - "routeFilters": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeFilters_routeFilterRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters" - }, - "routeFilters_routeFilterRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters/routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "routeTables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route table." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeTables_routes_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables" - }, - "routeTables_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "virtualNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworkGateways" - }, - "virtualNetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualNetworks_subnets_childResource" - }, - { - "$ref": "#/definitions/virtualNetworks_virtualNetworkPeerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks" - }, - "virtualNetworks_subnets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - } - }, - "definitions": { - "AddressSpace": { - "type": "object", - "properties": { - "addressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of address blocks reserved for this virtual network in CIDR notation." - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." - }, - "ApplicationGatewayAuthenticationCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Authentication certificates of an application gateway." - }, - "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Certificate public data." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Authentication certificates properties of an application gateway." - }, - "ApplicationGatewayBackendAddress": { - "type": "object", - "properties": { - "fqdn": { - "type": "string", - "description": "Fully qualified domain name (FQDN)." - }, - "ipAddress": { - "type": "string", - "description": "IP address" - } - }, - "description": "Backend address of an application gateway." - }, - "ApplicationGatewayBackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of references to IPs defined in network interfaces." - }, - "backendAddresses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddress" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend addresses" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendHttpSettings": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Backend address pool settings of an application gateway." - }, - "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Port" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "cookieBasedAffinity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cookie based affinity." - }, - "requestTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probe resource of an application gateway." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of references to application gateway authentication certificates." - }, - "connectionDraining": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayConnectionDraining" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connection draining of the backend http settings resource." - }, - "hostName": { - "type": "string", - "description": "Host header to be sent to the backend servers." - }, - "pickHostNameFromBackendAddress": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." - }, - "affinityCookieName": { - "type": "string", - "description": "Cookie name to use for the affinity cookie." - }, - "probeEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the probe is enabled. Default value is false." - }, - "path": { - "type": "string", - "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend address pool settings of an application gateway." - }, - "ApplicationGatewayConnectionDraining": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether connection draining is enabled or not." - }, - "drainTimeoutInSec": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 3600 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." - } - }, - "required": [ - "enabled", - "drainTimeoutInSec" - ], - "description": "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." - }, - "ApplicationGatewayFirewallDisabledRuleGroup": { - "type": "object", - "properties": { - "ruleGroupName": { - "type": "string", - "description": "The name of the rule group that will be disabled." - }, - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." - } - }, - "required": [ - "ruleGroupName" - ], - "description": "Allows to disable rules within a rule group or an entire rule group." - }, - "ApplicationGatewayFrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "PrivateIPAddress of the network interface IP Configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PrivateIP allocation method." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the PublicIP resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendPort": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Frontend port of an application gateway." - }, - "ApplicationGatewayFrontendPortPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend port of an application gateway." - }, - "ApplicationGatewayHttpListener": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Http listener of an application gateway." - }, - "ApplicationGatewayHttpListenerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP configuration resource of an application gateway." - }, - "frontendPort": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of an application gateway." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "hostName": { - "type": "string", - "description": "Host name of HTTP listener." - }, - "sslCertificate": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificate resource of an application gateway." - }, - "requireServerNameIndication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of HTTP listener of an application gateway." - }, - "ApplicationGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." - }, - "ApplicationGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration of an application gateway." - }, - "ApplicationGatewayPathRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Path rule of URL path map of an application gateway." - }, - "ApplicationGatewayPathRulePropertiesFormat": { - "type": "object", - "properties": { - "paths": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules of URL path map." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of URL path map path rule." - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings resource of URL path map path rule." - }, - "redirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configuration resource of URL path map path rule." - }, - "provisioningState": { - "type": "string", - "description": "Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of path rule of an application gateway." - }, - "ApplicationGatewayProbe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Probe of the application gateway." - }, - "ApplicationGatewayProbeHealthResponseMatch": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "Body that must be contained in the health response. Default value is empty." - }, - "statusCodes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." - } - }, - "description": "Application gateway probe health response match" - }, - "ApplicationGatewayProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "host": { - "type": "string", - "description": "Host name to send the probe to." - }, - "path": { - "type": "string", - "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:" - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." - }, - "timeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." - }, - "pickHostNameFromBackendHttpSettings": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the host header should be picked from the backend http settings. Default value is false." - }, - "minServers": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum number of servers that are always marked healthy. Default value is 0." - }, - "match": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Criterion for classifying a healthy probe response." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayPropertiesFormat": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU of the application gateway resource." - }, - "sslPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL policy of the application gateway resource." - }, - "gatewayIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnets of application the gateway resource." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Authentication certificates of the application gateway resource." - }, - "sslCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewaySslCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificates of the application gateway resource." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP addresses of the application gateway resource." - }, - "frontendPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendPort" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend ports of the application gateway resource." - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayProbe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probes of the application gateway resource." - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool of the application gateway resource." - }, - "backendHttpSettingsCollection": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings of the application gateway resource." - }, - "httpListeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayHttpListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listeners of the application gateway resource." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayUrlPathMap" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map of the application gateway resource." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing rules of the application gateway resource." - }, - "redirectConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configurations of the application gateway resource." - }, - "webApplicationFirewallConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall configuration." - }, - "resourceGuid": { - "type": "string", - "description": "Resource GUID property of the application gateway resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the application gateway." - }, - "ApplicationGatewayRedirectConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Redirect configuration of an application gateway." - }, - "ApplicationGatewayRedirectConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "redirectType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Permanent", - "Found", - "SeeOther", - "Temporary" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Supported http redirection types - Permanent, Temporary, Found, SeeOther." - }, - "targetListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference to a listener to redirect the request to." - }, - "targetUrl": { - "type": "string", - "description": "Url to redirect the request to." - }, - "includePath": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Include path in the redirected url." - }, - "includeQueryString": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Include query string in the redirected url." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing specifying redirect configuration." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Url path maps specifying default redirect configuration." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules specifying redirect configuration." - } - }, - "description": "Properties of redirect configuration of the application gateway." - }, - "ApplicationGatewayRequestRoutingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Request routing rule of an application gateway." - }, - "ApplicationGatewayRequestRoutingRulePropertiesFormat": { - "type": "object", - "properties": { - "ruleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "PathBasedRouting" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Rule type." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of the application gateway. " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of the application gateway." - }, - "httpListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listener resource of the application gateway. " - }, - "urlPathMap": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map resource of the application gateway." - }, - "redirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configuration resource of the application gateway." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of request routing rule of the application gateway." - }, - "ApplicationGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_Small", - "Standard_Medium", - "Standard_Large", - "WAF_Medium", - "WAF_Large" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of an application gateway SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "WAF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tier of an application gateway." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity (instance count) of an application gateway." - } - }, - "description": "SKU of an application gateway" - }, - "ApplicationGatewaySslCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "SSL certificates of an application gateway." - }, - "ApplicationGatewaySslCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." - }, - "password": { - "type": "string", - "description": "Password for the pfx file specified in data. Only applicable in PUT request." - }, - "publicCertData": { - "type": "string", - "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of SSL certificates of an application gateway." - }, - "ApplicationGatewaySslPolicy": { - "type": "object", - "properties": { - "disabledSslProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ssl protocols to be disabled on application gateway." - }, - "policyType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Predefined", - "Custom" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of Ssl Policy." - }, - "policyName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AppGwSslPolicy20150501", - "AppGwSslPolicy20170401", - "AppGwSslPolicy20170401S" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of Ssl predefined policy." - }, - "cipherSuites": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", - "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", - "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", - "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", - "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", - "TLS_RSA_WITH_AES_256_GCM_SHA384", - "TLS_RSA_WITH_AES_128_GCM_SHA256", - "TLS_RSA_WITH_AES_256_CBC_SHA256", - "TLS_RSA_WITH_AES_128_CBC_SHA256", - "TLS_RSA_WITH_AES_256_CBC_SHA", - "TLS_RSA_WITH_AES_128_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", - "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", - "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", - "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", - "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", - "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", - "TLS_RSA_WITH_3DES_EDE_CBC_SHA" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ssl cipher suites to be enabled in the specified order to application gateway." - }, - "minProtocolVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum version of Ssl protocol to be supported on application gateway." - } - }, - "description": "Application Gateway Ssl policy." - }, - "ApplicationGatewayUrlPathMap": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." - }, - "ApplicationGatewayUrlPathMapPropertiesFormat": { - "type": "object", - "properties": { - "defaultBackendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend address pool resource of URL path map." - }, - "defaultBackendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend http settings resource of URL path map." - }, - "defaultRedirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default redirect configuration resource of URL path map." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayPathRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rule of URL path map resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of UrlPathMap of the application gateway." - }, - "ApplicationGatewayWebApplicationFirewallConfiguration": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the web application firewall is enabled or not." - }, - "firewallMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Detection", - "Prevention" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall mode." - }, - "ruleSetType": { - "type": "string", - "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." - }, - "ruleSetVersion": { - "type": "string", - "description": "The version of the rule set type." - }, - "disabledRuleGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The disabled rule groups." - } - }, - "required": [ - "enabled", - "firewallMode", - "ruleSetType", - "ruleSetVersion" - ], - "description": "Application gateway web application firewall configuration." - }, - "AuthorizationPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorization key." - }, - "authorizationUseStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Available", - "InUse" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "BackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer backend address pool." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Pool of backend IP addresses." - }, - "BackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "description": "Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the backend address pool." - }, - "BgpSettings": { - "type": "object", - "properties": { - "asn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BGP speaker's ASN." - }, - "bgpPeeringAddress": { - "type": "string", - "description": "The BGP peering address and BGP identifier of this BGP speaker." - }, - "peerWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The weight added to routes learned from this BGP speaker." - } - }, - "description": "BGP settings details" - }, - "DhcpOptions": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of DNS servers IP addresses." - } - }, - "description": "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." - }, - "ExpressRouteCircuitAuthorization": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Authorization in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Peering in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "advertisedPublicPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of AdvertisedPublicPrefixes." - }, - "advertisedCommunities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The communities of bgp peering. Spepcified for microsoft peering" - }, - "advertisedPublicPrefixesState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotConfigured", - "Configuring", - "Configured", - "ValidationNeeded" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'." - }, - "legacyMode": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The legacy mode of the peering." - }, - "customerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CustomerASN of the peering." - }, - "routingRegistryName": { - "type": "string", - "description": "The RoutingRegistryName of the configuration." - } - }, - "description": "Specifies the peering configuration." - }, - "ExpressRouteCircuitPeeringPropertiesFormat": { - "type": "object", - "properties": { - "peeringType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzurePublicPeering", - "AzurePrivatePeering", - "MicrosoftPeering" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - }, - "azureASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Azure ASN." - }, - "peerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The peer ASN." - }, - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "primaryAzurePort": { - "type": "string", - "description": "The primary port." - }, - "secondaryAzurePort": { - "type": "string", - "description": "The secondary port." - }, - "sharedKey": { - "type": "string", - "description": "The shared key." - }, - "vlanId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The VLAN ID." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "stats": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitStats" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets peering stats." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets whether the provider or the customer last modified the peering." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "ipv6PeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPv6 peering configuration." - } - } - }, - "ExpressRouteCircuitPropertiesFormat": { - "type": "object", - "properties": { - "allowClassicOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allow classic operations" - }, - "circuitProvisioningState": { - "type": "string", - "description": "The CircuitProvisioningState state of the resource." - }, - "serviceProviderProvisioningState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotProvisioned", - "Provisioning", - "Provisioned", - "Deprovisioning" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'." - }, - "authorizations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitAuthorization" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of authorizations." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of peerings." - }, - "serviceKey": { - "type": "string", - "description": "The ServiceKey." - }, - "serviceProviderNotes": { - "type": "string", - "description": "The ServiceProviderNotes." - }, - "serviceProviderProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProperties." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - } - }, - "description": "Properties of ExpressRouteCircuit." - }, - "ExpressRouteCircuitServiceProviderProperties": { - "type": "object", - "properties": { - "serviceProviderName": { - "type": "string", - "description": "The serviceProviderName." - }, - "peeringLocation": { - "type": "string", - "description": "The peering location." - }, - "bandwidthInMbps": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BandwidthInMbps." - } - }, - "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium", - "Transport" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tier of the SKU. Possible values are 'Standard' and 'Premium'." - }, - "family": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UnlimitedData", - "MeteredData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'." - } - }, - "description": "Contains SKU in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitStats": { - "type": "object", - "properties": { - "primarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "primarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - }, - "secondarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "secondarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - } - }, - "description": "Contains stats associated with the peering." - }, - "expressRouteCircuits_authorizations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "FrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the load balancer probe." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "description": "Frontend IP address of the load balancer." - }, - "FrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "The private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the Public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP Configuration of the load balancer." - }, - "InboundNatPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat pool." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT pool of the load balancer." - }, - "InboundNatPoolPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPortRangeStart", - "frontendPortRangeEnd", - "backendPort" - ], - "description": "Properties of Inbound NAT pool." - }, - "InboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT rule of the load balancer." - }, - "InboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the inbound NAT rule." - }, - "IpsecPolicy": { - "type": "object", - "properties": { - "saLifeTimeSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." - }, - "saDataSizeKilobytes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." - }, - "ipsecEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DES", - "DES3", - "AES128", - "AES192", - "AES256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec encryption algorithm (IKE phase 1)." - }, - "ipsecIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec integrity algorithm (IKE phase 1)." - }, - "ikeEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "DES", - "DES3", - "AES128", - "AES192", - "AES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE encryption algorithm (IKE phase 2)." - }, - "ikeIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "SHA384" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE integrity algorithm (IKE phase 2)." - }, - "dhGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DHGroup1", - "DHGroup2", - "DHGroup14", - "DHGroup2048", - "ECP256", - "ECP384", - "DHGroup24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 1 for initial SA." - }, - "pfsGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "PFS1", - "PFS2", - "PFS2048", - "ECP256", - "ECP384", - "PFS24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 2 for new child SA." - } - }, - "required": [ - "saLifeTimeSeconds", - "saDataSizeKilobytes", - "ipsecEncryption", - "ipsecIntegrity", - "ikeEncryption", - "ikeIntegrity", - "dhGroup", - "pfsGroup" - ], - "description": "An IPSec Policy configuration for a virtual network gateway connection" - }, - "Ipv6ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - } - }, - "description": "Contains IPv6 peering config." - }, - "LoadBalancerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/FrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object representing the frontend IPs to be used for the load balancer" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of backend address pools used by a load balancer" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object collection representing the load balancing rules Gets the provisioning " - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Probe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of probe objects used in the load balancer" - }, - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/OutboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The outbound NAT rules." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the load balancer resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the load balancer." - }, - "loadBalancers_inboundNatRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "inboundNatRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers/inboundNatRules" - }, - "LoadBalancingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer load balancing rule." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancing rule for a load balancer." - }, - "LoadBalancingRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the load balancer probe used by the load balancing rule." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'." - }, - "loadDistribution": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "SourceIP", - "SourceIPProtocol" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. " - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPort" - ], - "description": "Properties of the load balancer." - }, - "LocalNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the local network gateway." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "LocalNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "localNetworkAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network site address space." - }, - "gatewayIpAddress": { - "type": "string", - "description": "IP address of local network gateway." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the LocalNetworkGateway resource." - } - }, - "description": "LocalNetworkGateway properties" - }, - "NetworkInterfaceDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "appliedDnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "internalDnsNameLabel": { - "type": "string", - "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." - }, - "internalFqdn": { - "type": "string", - "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." - }, - "internalDomainNameSuffix": { - "type": "string", - "description": "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." - } - }, - "description": "DNS settings of a network interface." - }, - "NetworkInterfaceIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network interface IP configuration properties." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IPConfiguration in a network interface." - }, - "NetworkInterfaceIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of ApplicationGatewayBackendAddressPool resource." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of LoadBalancerBackendAddressPool resource." - }, - "loadBalancerInboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references of LoadBalancerInboundNatRules." - }, - "privateIPAddress": { - "type": "string", - "description": "Private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnet bound to the IP configuration." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary customer address on the network interface." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address bound to the IP configuration." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration." - }, - "NetworkInterfacePropertiesFormat": { - "type": "object", - "properties": { - "virtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of a virtual machine." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of IPConfigurations of the network interface." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DNS settings in network interface." - }, - "macAddress": { - "type": "string", - "description": "The MAC address of the network interface." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary network interface on a virtual machine." - }, - "enableAcceleratedNetworking": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the network interface is accelerated networking enabled." - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether IP forwarding is enabled on this network interface." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network interface resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "NetworkInterface properties. " - }, - "NetworkSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network security group" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "NetworkSecurityGroup resource." - }, - "NetworkSecurityGroupPropertiesFormat": { - "type": "object", - "properties": { - "securityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of security rules of the network security group." - }, - "defaultSecurityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The default security rules of network security group." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network security group resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Network Security Group resource." - }, - "networkSecurityGroups_securityRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "NetworkWatcherPropertiesFormat": { - "type": "object", - "properties": {}, - "description": "The network watcher properties." - }, - "networkWatchers_packetCaptures_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "OutboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OutboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer outbound nat rule." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Outbound NAT pool of the load balancer." - }, - "OutboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "allocatedOutboundPorts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of outbound ports to be used for NAT." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Frontend IP addresses of the load balancer." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "backendAddressPool" - ], - "description": "Outbound NAT pool of the load balancer." - }, - "PacketCaptureFilter": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TCP", - "UDP", - "Any" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol to be filtered on." - }, - "localIPAddress": { - "type": "string", - "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." - }, - "remoteIPAddress": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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." - }, - "remotePort": { - "type": "string", - "description": "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." - } - }, - "description": "Filter that is applied to packet capture request. Multiple filters can be applied." - }, - "PacketCaptureParameters": { - "type": "object", - "properties": { - "target": { - "type": "string", - "description": "The ID of the targeted resource, only VM is currently supported." - }, - "bytesToCapturePerPacket": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of bytes captured per packet, the remaining bytes are truncated." - }, - "totalBytesPerSession": { - "oneOf": [ - { - "type": "integer", - "default": "1073741824" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum size of the capture output." - }, - "timeLimitInSeconds": { - "oneOf": [ - { - "type": "integer", - "default": "18000" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum duration of the capture session in seconds." - }, - "storageLocation": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureStorageLocation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "filters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PacketCaptureFilter" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "target", - "storageLocation" - ], - "description": "Parameters that define the create packet capture operation." - }, - "PacketCaptureStorageLocation": { - "type": "object", - "properties": { - "storageId": { - "type": "string", - "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." - }, - "storagePath": { - "type": "string", - "description": "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." - }, - "filePath": { - "type": "string", - "description": "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." - } - }, - "description": "Describes the storage location for a packet capture session." - }, - "Probe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer probe." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancer probe." - }, - "ProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." - }, - "intervalInSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "numberOfProbes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "requestPath": { - "type": "string", - "description": "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." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "port" - ], - "description": "Load balancer probe resource." - }, - "PublicIPAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address properties." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "description": "Public IP address resource." - }, - "PublicIPAddressDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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. " - } - }, - "description": "Contains FQDN of the DNS record associated with the public IP address" - }, - "PublicIPAddressPropertiesFormat": { - "type": "object", - "properties": { - "publicIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "publicIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The FQDN of the DNS record associated with the public IP address." - }, - "ipAddress": { - "type": "string", - "description": "The IP address associated with the public IP address resource." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The idle timeout of the public IP address." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Public IP address properties." - }, - "ResourceNavigationLink": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceNavigationLinkFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource navigation link properties format." - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "ResourceNavigationLink resource." - }, - "ResourceNavigationLinkFormat": { - "type": "object", - "properties": { - "linkedResourceType": { - "type": "string", - "description": "Resource type of the linked resource." - }, - "link": { - "type": "string", - "description": "Link to the external resource" - } - }, - "description": "Properties of ResourceNavigationLink." - }, - "Route": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route resource" - }, - "RouteFilter": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Route Filter Resource." - }, - "RouteFilterPropertiesFormat": { - "type": "object", - "properties": { - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RouteFilterRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of RouteFilterRules contained within a route filter." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of references to express route circuit peerings." - } - }, - "description": "Route Filter Resource" - }, - "RouteFilterRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "description": "Route Filter Rule Resource" - }, - "RouteFilterRulePropertiesFormat": { - "type": "object", - "properties": { - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The access type of the rule. Valid values are: 'Allow', 'Deny'." - }, - "routeFilterRuleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Community" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The rule type of the rule. Valid value is: 'Community'" - }, - "communities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']" - } - }, - "required": [ - "access", - "routeFilterRuleType", - "communities" - ], - "description": "Route Filter Rule Resource" - }, - "routeFilters_routeFilterRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "RoutePropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The destination CIDR to which the route applies." - }, - "nextHopType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VirtualNetworkGateway", - "VnetLocal", - "Internet", - "VirtualAppliance", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'." - }, - "nextHopIpAddress": { - "type": "string", - "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "nextHopType" - ], - "description": "Route resource" - }, - "RouteTable": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route table." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route table resource." - }, - "RouteTablePropertiesFormat": { - "type": "object", - "properties": { - "routes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Route" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of routes contained within a route table." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Route Table resource" - }, - "routeTables_routes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "SecurityRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Network security rule." - }, - "SecurityRulePropertiesFormat": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description for this rule. Restricted to 140 chars." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp", - "*" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'." - }, - "sourcePortRange": { - "type": "string", - "description": "The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "destinationPortRange": { - "type": "string", - "description": "The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "sourceAddressPrefix": { - "type": "string", - "description": "The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " - }, - "sourceAddressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CIDR or source IP ranges." - }, - "destinationAddressPrefix": { - "type": "string", - "description": "The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." - }, - "destinationAddressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The destination address prefixes. CIDR or destination IP ranges." - }, - "sourcePortRanges": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source port ranges." - }, - "destinationPortRanges": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The destination port ranges." - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'." - }, - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "access", - "direction" - ], - "description": "Security rule resource." - }, - "ServiceEndpointPropertiesFormat": { - "type": "object", - "properties": { - "service": { - "type": "string", - "description": "The type of the endpoint service." - }, - "locations": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of locations." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "The service endpoint properties." - }, - "Subnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Subnet in a virtual network resource." - }, - "SubnetPropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The address prefix for the subnet." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "routeTable": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTable" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteTable resource." - }, - "serviceEndpoints": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceEndpointPropertiesFormat" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An array of service endpoints." - }, - "resourceNavigationLinks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceNavigationLink" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets an array of references to the external resources using subnet." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "Properties of the subnet." - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - } - }, - "description": "Reference to another subresource." - }, - "VirtualNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "VirtualNetworkGatewayConnectionPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorizationKey." - }, - "virtualNetworkGateway1": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to virtual network gateway resource." - }, - "virtualNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to virtual network gateway resource." - }, - "localNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to local network gateway resource." - }, - "connectionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPsec", - "Vnet2Vnet", - "ExpressRoute", - "VPNClient" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient." - }, - "routingWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The routing weight." - }, - "sharedKey": { - "type": "string", - "description": "The IPSec shared key." - }, - "peer": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to peerings resource." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp flag" - }, - "usePolicyBasedTrafficSelectors": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Enable policy-based traffic selectors." - }, - "ipsecPolicies": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IpsecPolicy" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Policies to be considered by this connection." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." - } - }, - "required": [ - "virtualNetworkGateway1", - "connectionType" - ], - "description": "VirtualNetworkGatewayConnection properties" - }, - "VirtualNetworkGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway ip configuration." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration for virtual network gateway" - }, - "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the public IP resource." - } - }, - "description": "Properties of VirtualNetworkGatewayIPConfiguration" - }, - "VirtualNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IP configurations for virtual network gateway." - }, - "gatewayType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Vpn", - "ExpressRoute" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PolicyBased", - "RouteBased" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether BGP is enabled for this virtual network gateway or not." - }, - "activeActive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "ActiveActive flag" - }, - "gatewayDefaultSite": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." - }, - "vpnClientConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGateway resource." - } - }, - "description": "VirtualNetworkGateway properties" - }, - "VirtualNetworkGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU name." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU tier." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity." - } - }, - "description": "VirtualNetworkGatewaySku details" - }, - "VirtualNetworkPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Peerings in a virtual network resource." - }, - "VirtualNetworkPeeringPropertiesFormat": { - "type": "object", - "properties": { - "allowVirtualNetworkAccess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space." - }, - "allowForwardedTraffic": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed." - }, - "allowGatewayTransit": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If gateway links can be used in remote virtual networking to link to this virtual network." - }, - "useRemoteGateways": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "remoteVirtualNetwork": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the remote virtual network." - }, - "peeringState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Initiated", - "Connected", - "Disconnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "Properties of the virtual network peering." - }, - "VirtualNetworkPropertiesFormat": { - "type": "object", - "properties": { - "addressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." - }, - "dhcpOptions": { - "oneOf": [ - { - "$ref": "#/definitions/DhcpOptions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of subnets in a Virtual Network." - }, - "virtualNetworkPeerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of peerings in a Virtual Network." - }, - "resourceGuid": { - "type": "string", - "description": "The resourceGuid property of the Virtual Network resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the virtual network." - }, - "virtualNetworks_subnets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - }, - "VpnClientConfiguration": { - "type": "object", - "properties": { - "vpnClientAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the address space resource which represents Address space for P2S VpnClient." - }, - "vpnClientRootCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRootCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRootCertificate for virtual network gateway." - }, - "vpnClientRevokedCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRevokedCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRevokedCertificate for Virtual network gateway." - }, - "vpnClientProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "IkeV2", - "SSTP" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientProtocols for Virtual network gateway." - }, - "radiusServerAddress": { - "type": "string", - "description": "The radius server address property of the VirtualNetworkGateway resource for vpn client connection." - }, - "radiusServerSecret": { - "type": "string", - "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection." - } - }, - "description": "VpnClientConfiguration for P2S client." - }, - "VpnClientRevokedCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the vpn client revoked certificate." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "VPN client revoked certificate of virtual network gateway." - }, - "VpnClientRevokedCertificatePropertiesFormat": { - "type": "object", - "properties": { - "thumbprint": { - "type": "string", - "description": "The revoked VPN client certificate thumbprint." - } - }, - "description": "Properties of the revoked VPN client certificate of virtual network gateway." - }, - "VpnClientRootCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the vpn client root certificate." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "VPN client root certificate of virtual network gateway" - }, - "VpnClientRootCertificatePropertiesFormat": { - "type": "object", - "properties": { - "publicCertData": { - "type": "string", - "description": "The certificate public data." - } - }, - "required": [ - "publicCertData" - ], - "description": "Properties of SSL certificates of application gateway" - } - } -} diff --git a/test/Resource/Expected/Network/2017-06-01/applicationGateways.md b/test/Resource/Expected/Network/2017-06-01/applicationGateways.md deleted file mode 100644 index 744659a..0000000 --- a/test/Resource/Expected/Network/2017-06-01/applicationGateways.md +++ /dev/null @@ -1,1152 +0,0 @@ -# Microsoft.Network/applicationGateways template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/applicationGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationGateways", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "sslPolicy": { - "disabledSslProtocols": [ - "string" - ], - "policyType": "string", - "policyName": "string", - "cipherSuites": [ - "string" - ], - "minProtocolVersion": "string" - }, - "gatewayIPConfigurations": [ - { - "id": "string", - "properties": { - "subnet": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "authenticationCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "sslCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "password": "string", - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "frontendPorts": [ - { - "id": "string", - "properties": { - "port": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "host": "string", - "path": "string", - "interval": "integer", - "timeout": "integer", - "unhealthyThreshold": "integer", - "pickHostNameFromBackendHttpSettings": "boolean", - "minServers": "integer", - "match": { - "body": "string", - "statusCodes": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - "ApplicationGatewayBackendAddressPool" - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "backendHttpSettingsCollection": [ - { - "id": "string", - "properties": { - "port": "integer", - "protocol": "string", - "cookieBasedAffinity": "string", - "requestTimeout": "integer", - "probe": { - "id": "string" - }, - "authenticationCertificates": [ - { - "id": "string" - } - ], - "connectionDraining": { - "enabled": "boolean", - "drainTimeoutInSec": "integer" - }, - "hostName": "string", - "pickHostNameFromBackendAddress": "boolean", - "affinityCookieName": "string", - "probeEnabled": "boolean", - "path": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "httpListeners": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "frontendPort": { - "id": "string" - }, - "protocol": "string", - "hostName": "string", - "sslCertificate": { - "id": "string" - }, - "requireServerNameIndication": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "urlPathMaps": [ - { - "id": "string", - "properties": { - "defaultBackendAddressPool": { - "id": "string" - }, - "defaultBackendHttpSettings": { - "id": "string" - }, - "defaultRedirectConfiguration": { - "id": "string" - }, - "pathRules": [ - { - "id": "string", - "properties": { - "paths": [ - "string" - ], - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "redirectConfiguration": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "requestRoutingRules": [ - { - "id": "string", - "properties": { - "ruleType": "string", - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "httpListener": { - "id": "string" - }, - "urlPathMap": { - "id": "string" - }, - "redirectConfiguration": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "redirectConfigurations": [ - { - "id": "string", - "properties": { - "redirectType": "string", - "targetListener": { - "id": "string" - }, - "targetUrl": "string", - "includePath": "boolean", - "includeQueryString": "boolean", - "requestRoutingRules": [ - { - "id": "string" - } - ], - "urlPathMaps": [ - { - "id": "string" - } - ], - "pathRules": [ - { - "id": "string" - } - ] - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "webApplicationFirewallConfiguration": { - "enabled": "boolean", - "firewallMode": "string", - "ruleSetType": "string", - "ruleSetVersion": "string", - "disabledRuleGroups": [ - { - "ruleGroupName": "string", - "rules": [ - "integer" - ] - } - ] - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationGateways | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [ApplicationGatewayPropertiesFormat object](#ApplicationGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | SKU of the application gateway resource. - [ApplicationGatewaySku object](#ApplicationGatewaySku) | -| sslPolicy | object | No | SSL policy of the application gateway resource. - [ApplicationGatewaySslPolicy object](#ApplicationGatewaySslPolicy) | -| gatewayIPConfigurations | array | No | Subnets of application the gateway resource. - [ApplicationGatewayIPConfiguration object](#ApplicationGatewayIPConfiguration) | -| authenticationCertificates | array | No | Authentication certificates of the application gateway resource. - [ApplicationGatewayAuthenticationCertificate object](#ApplicationGatewayAuthenticationCertificate) | -| sslCertificates | array | No | SSL certificates of the application gateway resource. - [ApplicationGatewaySslCertificate object](#ApplicationGatewaySslCertificate) | -| frontendIPConfigurations | array | No | Frontend IP addresses of the application gateway resource. - [ApplicationGatewayFrontendIPConfiguration object](#ApplicationGatewayFrontendIPConfiguration) | -| frontendPorts | array | No | Frontend ports of the application gateway resource. - [ApplicationGatewayFrontendPort object](#ApplicationGatewayFrontendPort) | -| probes | array | No | Probes of the application gateway resource. - [ApplicationGatewayProbe object](#ApplicationGatewayProbe) | -| backendAddressPools | array | No | Backend address pool of the application gateway resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| backendHttpSettingsCollection | array | No | Backend http settings of the application gateway resource. - [ApplicationGatewayBackendHttpSettings object](#ApplicationGatewayBackendHttpSettings) | -| httpListeners | array | No | Http listeners of the application gateway resource. - [ApplicationGatewayHttpListener object](#ApplicationGatewayHttpListener) | -| urlPathMaps | array | No | URL path map of the application gateway resource. - [ApplicationGatewayUrlPathMap object](#ApplicationGatewayUrlPathMap) | -| requestRoutingRules | array | No | Request routing rules of the application gateway resource. - [ApplicationGatewayRequestRoutingRule object](#ApplicationGatewayRequestRoutingRule) | -| redirectConfigurations | array | No | Redirect configurations of the application gateway resource. - [ApplicationGatewayRedirectConfiguration object](#ApplicationGatewayRedirectConfiguration) | -| webApplicationFirewallConfiguration | object | No | Web application firewall configuration. - [ApplicationGatewayWebApplicationFirewallConfiguration object](#ApplicationGatewayWebApplicationFirewallConfiguration) | -| resourceGuid | string | No | Resource GUID property of the application gateway resource. | -| provisioningState | string | No | Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of an application gateway SKU. - Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large | -| tier | enum | No | Tier of an application gateway. - Standard or WAF | -| capacity | integer | No | Capacity (instance count) of an application gateway. | - - - -### ApplicationGatewaySslPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disabledSslProtocols | array | No | Ssl protocols to be disabled on application gateway. - TLSv1_0, TLSv1_1, TLSv1_2 | -| policyType | enum | No | Type of Ssl Policy. - Predefined or Custom | -| policyName | enum | No | Name of Ssl predefined policy. - AppGwSslPolicy20150501, AppGwSslPolicy20170401, AppGwSslPolicy20170401S | -| cipherSuites | array | No | Ssl cipher suites to be enabled in the specified order to application gateway. - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA | -| minProtocolVersion | enum | No | Minimum version of Ssl protocol to be supported on application gateway. - TLSv1_0, TLSv1_1, TLSv1_2 | - - - -### ApplicationGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayIPConfigurationPropertiesFormat object](#ApplicationGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayAuthenticationCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayAuthenticationCertificatePropertiesFormat object](#ApplicationGatewayAuthenticationCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewaySslCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewaySslCertificatePropertiesFormat object](#ApplicationGatewaySslCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayFrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendIPConfigurationPropertiesFormat object](#ApplicationGatewayFrontendIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayFrontendPort object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendPortPropertiesFormat object](#ApplicationGatewayFrontendPortPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayProbe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayProbePropertiesFormat object](#ApplicationGatewayProbePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayBackendHttpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendHttpSettingsPropertiesFormat object](#ApplicationGatewayBackendHttpSettingsPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayHttpListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayHttpListenerPropertiesFormat object](#ApplicationGatewayHttpListenerPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayUrlPathMap object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayUrlPathMapPropertiesFormat object](#ApplicationGatewayUrlPathMapPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayRequestRoutingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRequestRoutingRulePropertiesFormat object](#ApplicationGatewayRequestRoutingRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayRedirectConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRedirectConfigurationPropertiesFormat object](#ApplicationGatewayRedirectConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayWebApplicationFirewallConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether the web application firewall is enabled or not. | -| firewallMode | enum | Yes | Web application firewall mode. - Detection or Prevention | -| ruleSetType | string | Yes | The type of the web application firewall rule set. Possible values are: 'OWASP'. | -| ruleSetVersion | string | Yes | The version of the rule set type. | -| disabledRuleGroups | array | No | The disabled rule groups. - [ApplicationGatewayFirewallDisabledRuleGroup object](#ApplicationGatewayFirewallDisabledRuleGroup) | - - - -### ApplicationGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Reference of the subnet resource. A subnet from where application gateway gets its private address. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayAuthenticationCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Certificate public data. | -| provisioningState | string | No | Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySslCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Base-64 encoded pfx certificate. Only applicable in PUT Request. | -| password | string | No | Password for the pfx file specified in data. Only applicable in PUT request. | -| publicCertData | string | No | Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. | -| provisioningState | string | No | Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | PrivateIPAddress of the network interface IP Configuration. | -| privateIPAllocationMethod | enum | No | PrivateIP allocation method. - Static or Dynamic | -| subnet | object | No | Reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Reference of the PublicIP resource. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendPortPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Frontend port | -| provisioningState | string | No | Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol. - Http or Https | -| host | string | No | Host name to send the probe to. | -| path | string | No | Relative path of probe. Valid path starts from '/'. Probe is sent to ://: | -| interval | integer | No | The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. | -| timeout | integer | No | 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 | integer | No | The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. | -| pickHostNameFromBackendHttpSettings | boolean | No | Whether the host header should be picked from the backend http settings. Default value is false. | -| minServers | integer | No | Minimum number of servers that are always marked healthy. Default value is 0. | -| match | object | No | Criterion for classifying a healthy probe response. - [ApplicationGatewayProbeHealthResponseMatch object](#ApplicationGatewayProbeHealthResponseMatch) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendHttpSettingsPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Port | -| protocol | enum | No | Protocol. - Http or Https | -| cookieBasedAffinity | enum | No | Cookie based affinity. - Enabled or Disabled | -| requestTimeout | integer | No | 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. | -| probe | object | No | Probe resource of an application gateway. - [SubResource object](#SubResource) | -| authenticationCertificates | array | No | Array of references to application gateway authentication certificates. - [SubResource object](#SubResource) | -| connectionDraining | object | No | Connection draining of the backend http settings resource. - [ApplicationGatewayConnectionDraining object](#ApplicationGatewayConnectionDraining) | -| hostName | string | No | Host header to be sent to the backend servers. | -| pickHostNameFromBackendAddress | boolean | No | Whether to pick host header should be picked from the host name of the backend server. Default value is false. | -| affinityCookieName | string | No | Cookie name to use for the affinity cookie. | -| probeEnabled | boolean | No | Whether the probe is enabled. Default value is false. | -| path | string | No | Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayHttpListenerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Frontend IP configuration resource of an application gateway. - [SubResource object](#SubResource) | -| frontendPort | object | No | Frontend port resource of an application gateway. - [SubResource object](#SubResource) | -| protocol | enum | No | Protocol. - Http or Https | -| hostName | string | No | Host name of HTTP listener. | -| sslCertificate | object | No | SSL certificate resource of an application gateway. - [SubResource object](#SubResource) | -| requireServerNameIndication | boolean | No | Applicable only if protocol is https. Enables SNI for multi-hosting. | -| provisioningState | string | No | Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayUrlPathMapPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultBackendAddressPool | object | No | Default backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| defaultBackendHttpSettings | object | No | Default backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| defaultRedirectConfiguration | object | No | Default redirect configuration resource of URL path map. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rule of URL path map resource. - [ApplicationGatewayPathRule object](#ApplicationGatewayPathRule) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRequestRoutingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleType | enum | No | Rule type. - Basic or PathBasedRouting | -| backendAddressPool | object | No | Backend address pool resource of the application gateway. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Frontend port resource of the application gateway. - [SubResource object](#SubResource) | -| httpListener | object | No | Http listener resource of the application gateway. - [SubResource object](#SubResource) | -| urlPathMap | object | No | URL path map resource of the application gateway. - [SubResource object](#SubResource) | -| redirectConfiguration | object | No | Redirect configuration resource of the application gateway. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRedirectConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| redirectType | enum | No | Supported http redirection types - Permanent, Temporary, Found, SeeOther. - Permanent, Found, SeeOther, Temporary | -| targetListener | object | No | Reference to a listener to redirect the request to. - [SubResource object](#SubResource) | -| targetUrl | string | No | Url to redirect the request to. | -| includePath | boolean | No | Include path in the redirected url. | -| includeQueryString | boolean | No | Include query string in the redirected url. | -| requestRoutingRules | array | No | Request routing specifying redirect configuration. - [SubResource object](#SubResource) | -| urlPathMaps | array | No | Url path maps specifying default redirect configuration. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rules specifying redirect configuration. - [SubResource object](#SubResource) | - - - -### ApplicationGatewayFirewallDisabledRuleGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleGroupName | string | Yes | The name of the rule group that will be disabled. | -| rules | array | No | The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - integer | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### ApplicationGatewayProbeHealthResponseMatch object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| body | string | No | Body that must be contained in the health response. Default value is empty. | -| statusCodes | array | No | Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - string | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Network interface IP configuration properties. - [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### ApplicationGatewayConnectionDraining object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether connection draining is enabled or not. | -| drainTimeoutInSec | integer | Yes | The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. | - - - -### ApplicationGatewayPathRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayPathRulePropertiesFormat object](#ApplicationGatewayPathRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | Private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | Subnet bound to the IP configuration. - [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | Public IP address bound to the IP configuration. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayPathRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| paths | array | No | Path rules of URL path map. - string | -| backendAddressPool | object | No | Backend address pool resource of URL path map path rule. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Backend http settings resource of URL path map path rule. - [SubResource object](#SubResource) | -| redirectConfiguration | object | No | Redirect configuration resource of URL path map path rule. - [SubResource object](#SubResource) | -| provisioningState | string | No | Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/connections.md b/test/Resource/Expected/Network/2017-06-01/connections.md deleted file mode 100644 index be64a9c..0000000 --- a/test/Resource/Expected/Network/2017-06-01/connections.md +++ /dev/null @@ -1,403 +0,0 @@ -# Microsoft.Network/connections template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/connections", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "authorizationKey": "string", - "virtualNetworkGateway1": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "virtualNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "localNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "connectionType": "string", - "routingWeight": "integer", - "sharedKey": "string", - "peer": { - "id": "string" - }, - "enableBgp": "boolean", - "usePolicyBasedTrafficSelectors": "boolean", - "ipsecPolicies": [ - { - "saLifeTimeSeconds": "integer", - "saDataSizeKilobytes": "integer", - "ipsecEncryption": "string", - "ipsecIntegrity": "string", - "ikeEncryption": "string", - "ikeIntegrity": "string", - "dhGroup": "string", - "pfsGroup": "string" - } - ], - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/connections | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway connection. - [VirtualNetworkGatewayConnectionPropertiesFormat object](#VirtualNetworkGatewayConnectionPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayConnectionPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorizationKey. | -| virtualNetworkGateway1 | object | Yes | The reference to virtual network gateway resource. - [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| virtualNetworkGateway2 | object | No | The reference to virtual network gateway resource. - [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| localNetworkGateway2 | object | No | The reference to local network gateway resource. - [LocalNetworkGateway object](#LocalNetworkGateway) | -| connectionType | enum | Yes | Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. - IPsec, Vnet2Vnet, ExpressRoute, VPNClient | -| routingWeight | integer | No | The routing weight. | -| sharedKey | string | No | The IPSec shared key. | -| peer | object | No | The reference to peerings resource. - [SubResource object](#SubResource) | -| enableBgp | boolean | No | EnableBgp flag | -| usePolicyBasedTrafficSelectors | boolean | No | Enable policy-based traffic selectors. | -| ipsecPolicies | array | No | The IPSec Policies to be considered by this connection. - [IpsecPolicy object](#IpsecPolicy) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGatewayConnection resource. | - - - -### VirtualNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway. - [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the local network gateway. - [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### IpsecPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| saLifeTimeSeconds | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. | -| saDataSizeKilobytes | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. | -| ipsecEncryption | enum | Yes | The IPSec encryption algorithm (IKE phase 1). - None, DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256 | -| ipsecIntegrity | enum | Yes | The IPSec integrity algorithm (IKE phase 1). - MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256 | -| ikeEncryption | enum | Yes | The IKE encryption algorithm (IKE phase 2). - DES, DES3, AES128, AES192, AES256 | -| ikeIntegrity | enum | Yes | The IKE integrity algorithm (IKE phase 2). - MD5, SHA1, SHA256, SHA384 | -| dhGroup | enum | Yes | The DH Groups used in IKE Phase 1 for initial SA. - None, DHGroup1, DHGroup2, DHGroup14, DHGroup2048, ECP256, ECP384, DHGroup24 | -| pfsGroup | enum | Yes | The DH Groups used in IKE Phase 2 for new child SA. - None, PFS1, PFS2, PFS2048, ECP256, ECP384, PFS24 | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network gateway ip configuration. - [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | -| vpnClientProtocols | array | No | VpnClientProtocols for Virtual network gateway. - IkeV2 or SSTP | -| radiusServerAddress | string | No | The radius server address property of the VirtualNetworkGateway resource for vpn client connection. | -| radiusServerSecret | string | No | The radius secret property of the VirtualNetworkGateway resource for vpn client connection. | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the vpn client root certificate. - [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the vpn client revoked certificate. - [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-06-01/expressRouteCircuits.md b/test/Resource/Expected/Network/2017-06-01/expressRouteCircuits.md deleted file mode 100644 index 1855a7e..0000000 --- a/test/Resource/Expected/Network/2017-06-01/expressRouteCircuits.md +++ /dev/null @@ -1,326 +0,0 @@ -# Microsoft.Network/expressRouteCircuits template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "family": "string" - }, - "properties": { - "allowClassicOperations": "boolean", - "circuitProvisioningState": "string", - "serviceProviderProvisioningState": "string", - "authorizations": [ - { - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "name": "string" - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - "ExpressRouteCircuitPeering" - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - "ExpressRouteCircuitPeering" - ] - } - }, - "state": "string" - } - }, - "name": "string" - } - ], - "serviceKey": "string", - "serviceProviderNotes": "string", - "serviceProviderProperties": { - "serviceProviderName": "string", - "peeringLocation": "string", - "bandwidthInMbps": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The SKU. - [ExpressRouteCircuitSku object](#ExpressRouteCircuitSku) | -| properties | object | Yes | [ExpressRouteCircuitPropertiesFormat object](#ExpressRouteCircuitPropertiesFormat) | -| resources | array | No | [peerings](./expressRouteCircuits/peerings.md) [authorizations](./expressRouteCircuits/authorizations.md) | - - - -### ExpressRouteCircuitSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the SKU. | -| tier | enum | No | The tier of the SKU. Possible values are 'Standard' and 'Premium'. - Standard, Premium, Transport | -| family | enum | No | The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. - UnlimitedData or MeteredData | - - - -### ExpressRouteCircuitPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowClassicOperations | boolean | No | Allow classic operations | -| circuitProvisioningState | string | No | The CircuitProvisioningState state of the resource. | -| serviceProviderProvisioningState | enum | No | The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - NotProvisioned, Provisioning, Provisioned, Deprovisioning | -| authorizations | array | No | The list of authorizations. - [ExpressRouteCircuitAuthorization object](#ExpressRouteCircuitAuthorization) | -| peerings | array | No | The list of peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | -| serviceKey | string | No | The ServiceKey. | -| serviceProviderNotes | string | No | The ServiceProviderNotes. | -| serviceProviderProperties | object | No | The ServiceProviderProperties. - [ExpressRouteCircuitServiceProviderProperties object](#ExpressRouteCircuitServiceProviderProperties) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | - - - -### ExpressRouteCircuitAuthorization object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitServiceProviderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceProviderName | string | No | The serviceProviderName. | -| peeringLocation | string | No | The peering location. | -| bandwidthInMbps | integer | No | The BandwidthInMbps. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-06-01/expressRouteCircuits/authorizations.md b/test/Resource/Expected/Network/2017-06-01/expressRouteCircuits/authorizations.md deleted file mode 100644 index 27ed396..0000000 --- a/test/Resource/Expected/Network/2017-06-01/expressRouteCircuits/authorizations.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/authorizations template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/authorizations", - "apiVersion": "2017-06-01", - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/authorizations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/authorizations | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/expressRouteCircuits/peerings.md b/test/Resource/Expected/Network/2017-06-01/expressRouteCircuits/peerings.md deleted file mode 100644 index c71558c..0000000 --- a/test/Resource/Expected/Network/2017-06-01/expressRouteCircuits/peerings.md +++ /dev/null @@ -1,239 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/peerings template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/peerings", - "apiVersion": "2017-06-01", - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": "ExpressRouteCircuitPeeringPropertiesFormat", - "name": "string" - } - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": "ExpressRouteCircuitPeeringPropertiesFormat", - "name": "string" - } - ] - } - }, - "state": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/peerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/peerings | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-06-01/loadBalancers.md b/test/Resource/Expected/Network/2017-06-01/loadBalancers.md deleted file mode 100644 index 1da8f4d..0000000 --- a/test/Resource/Expected/Network/2017-06-01/loadBalancers.md +++ /dev/null @@ -1,649 +0,0 @@ -# Microsoft.Network/loadBalancers template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/loadBalancers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "zones": [ - "string" - ] - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendAddressPool": { - "id": "string" - }, - "probe": { - "id": "string" - }, - "protocol": "string", - "loadDistribution": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "port": "integer", - "intervalInSeconds": "integer", - "numberOfProbes": "integer", - "requestPath": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatPools": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "backendPort": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "outboundNatRules": [ - { - "id": "string", - "properties": { - "allocatedOutboundPorts": "integer", - "frontendIPConfigurations": [ - { - "id": "string" - } - ], - "backendAddressPool": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of load balancer. - [LoadBalancerPropertiesFormat object](#LoadBalancerPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [inboundNatRules](./loadBalancers/inboundNatRules.md) | - - - -### LoadBalancerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfigurations | array | No | Object representing the frontend IPs to be used for the load balancer - [FrontendIPConfiguration object](#FrontendIPConfiguration) | -| backendAddressPools | array | No | Collection of backend address pools used by a load balancer - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancingRules | array | No | Object collection representing the load balancing rules Gets the provisioning - [LoadBalancingRule object](#LoadBalancingRule) | -| probes | array | No | Collection of probe objects used in the load balancer - [Probe object](#Probe) | -| inboundNatRules | array | No | 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. - [InboundNatRule object](#InboundNatRule) | -| inboundNatPools | array | No | 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. - [InboundNatPool object](#InboundNatPool) | -| outboundNatRules | array | No | The outbound NAT rules. - [OutboundNatRule object](#OutboundNatRule) | -| resourceGuid | string | No | The resource GUID property of the load balancer resource. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### FrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the load balancer probe. - [FrontendIPConfigurationPropertiesFormat object](#FrontendIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer load balancing rule. - [LoadBalancingRulePropertiesFormat object](#LoadBalancingRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Probe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer probe. - [ProbePropertiesFormat object](#ProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat pool. - [InboundNatPoolPropertiesFormat object](#InboundNatPoolPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### OutboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer outbound nat rule. - [OutboundNatRulePropertiesFormat object](#OutboundNatRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### FrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | The private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [Subnet object](#Subnet) | -| publicIPAddress | object | No | The reference of the Public IP resource. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### LoadBalancingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| backendAddressPool | object | No | A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| probe | object | No | The reference of the load balancer probe used by the load balancing rule. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'. - Udp or Tcp | -| loadDistribution | enum | No | The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. - Default, SourceIP, SourceIPProtocol | -| frontendPort | integer | Yes | 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. | -| backendPort | integer | No | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | Yes | 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. - Http or Tcp | -| port | integer | Yes | The port for communicating the probe. Possible values range from 1 to 65535, inclusive. | -| intervalInSeconds | integer | No | 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. | -| numberOfProbes | integer | No | 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. | -| requestPath | string | No | 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. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPortRangeStart | integer | Yes | 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. | -| frontendPortRangeEnd | integer | Yes | 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. | -| backendPort | integer | Yes | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### OutboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allocatedOutboundPorts | integer | No | The number of outbound ports to be used for NAT. | -| frontendIPConfigurations | array | No | The Frontend IP addresses of the load balancer. - [SubResource object](#SubResource) | -| backendAddressPool | object | Yes | A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/loadBalancers/inboundNatRules.md b/test/Resource/Expected/Network/2017-06-01/loadBalancers/inboundNatRules.md deleted file mode 100644 index 75abb81..0000000 --- a/test/Resource/Expected/Network/2017-06-01/loadBalancers/inboundNatRules.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/loadBalancers/inboundNatRules template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/loadBalancers/inboundNatRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers/inboundNatRules", - "apiVersion": "2017-06-01", - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers/inboundNatRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers/inboundNatRules | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - diff --git a/test/Resource/Expected/Network/2017-06-01/localNetworkGateways.md b/test/Resource/Expected/Network/2017-06-01/localNetworkGateways.md deleted file mode 100644 index c04434a..0000000 --- a/test/Resource/Expected/Network/2017-06-01/localNetworkGateways.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/localNetworkGateways template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/localNetworkGateways", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/localNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/localNetworkGateways | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the local network gateway. - [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - diff --git a/test/Resource/Expected/Network/2017-06-01/networkInterfaces.md b/test/Resource/Expected/Network/2017-06-01/networkInterfaces.md deleted file mode 100644 index 7a165a3..0000000 --- a/test/Resource/Expected/Network/2017-06-01/networkInterfaces.md +++ /dev/null @@ -1,634 +0,0 @@ -# Microsoft.Network/networkInterfaces template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/networkInterfaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkInterfaces", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableAcceleratedNetworking": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkInterfaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkInterfaces | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the network interface. - [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | The reference of a virtual machine. - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | A list of IPConfigurations of the network interface. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | The DNS settings in network interface. - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | The MAC address of the network interface. | -| primary | boolean | No | Gets whether this is a primary network interface on a virtual machine. | -| enableAcceleratedNetworking | boolean | No | If the network interface is accelerated networking enabled. | -| enableIPForwarding | boolean | No | Indicates whether IP forwarding is enabled on this network interface. | -| resourceGuid | string | No | The resource GUID property of the network interface resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Network interface IP configuration properties. - [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | 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. - string | -| appliedDnsServers | array | No | 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. - string | -| internalDnsNameLabel | string | No | Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. | -| internalFqdn | string | No | Fully qualified DNS name supporting internal communications between VMs in the same virtual network. | -| internalDomainNameSuffix | string | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | Private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | Subnet bound to the IP configuration. - [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | Public IP address bound to the IP configuration. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/networkSecurityGroups.md b/test/Resource/Expected/Network/2017-06-01/networkSecurityGroups.md deleted file mode 100644 index 5245134..0000000 --- a/test/Resource/Expected/Network/2017-06-01/networkSecurityGroups.md +++ /dev/null @@ -1,142 +0,0 @@ -# Microsoft.Network/networkSecurityGroups template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [securityRules](./networkSecurityGroups/securityRules.md) | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/networkSecurityGroups/securityRules.md b/test/Resource/Expected/Network/2017-06-01/networkSecurityGroups/securityRules.md deleted file mode 100644 index 92fb576..0000000 --- a/test/Resource/Expected/Network/2017-06-01/networkSecurityGroups/securityRules.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/networkSecurityGroups/securityRules template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups/securityRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups/securityRules", - "apiVersion": "2017-06-01", - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups/securityRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups/securityRules | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/networkWatchers.md b/test/Resource/Expected/Network/2017-06-01/networkWatchers.md deleted file mode 100644 index 73141e8..0000000 --- a/test/Resource/Expected/Network/2017-06-01/networkWatchers.md +++ /dev/null @@ -1,37 +0,0 @@ -# Microsoft.Network/networkWatchers template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/networkWatchers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "etag": "string", - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| properties | object | Yes | [NetworkWatcherPropertiesFormat object](#NetworkWatcherPropertiesFormat) | -| resources | array | No | [packetCaptures](./networkWatchers/packetCaptures.md) | - diff --git a/test/Resource/Expected/Network/2017-06-01/networkWatchers/packetCaptures.md b/test/Resource/Expected/Network/2017-06-01/networkWatchers/packetCaptures.md deleted file mode 100644 index 7669768..0000000 --- a/test/Resource/Expected/Network/2017-06-01/networkWatchers/packetCaptures.md +++ /dev/null @@ -1,78 +0,0 @@ -# Microsoft.Network/networkWatchers/packetCaptures template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers/packetCaptures", - "apiVersion": "2017-06-01", - "properties": { - "target": "string", - "bytesToCapturePerPacket": "integer", - "totalBytesPerSession": "integer", - "timeLimitInSeconds": "integer", - "storageLocation": { - "storageId": "string", - "storagePath": "string", - "filePath": "string" - }, - "filters": [ - { - "protocol": "string", - "localIPAddress": "string", - "remoteIPAddress": "string", - "localPort": "string", - "remotePort": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers/packetCaptures object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers/packetCaptures | -| apiVersion | enum | Yes | 2017-06-01 | -| properties | object | Yes | [PacketCaptureParameters object](#PacketCaptureParameters) | - - - -### PacketCaptureParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| target | string | Yes | The ID of the targeted resource, only VM is currently supported. | -| bytesToCapturePerPacket | integer | No | Number of bytes captured per packet, the remaining bytes are truncated. | -| totalBytesPerSession | integer | No | Maximum size of the capture output. | -| timeLimitInSeconds | integer | No | Maximum duration of the capture session in seconds. | -| storageLocation | object | Yes | [PacketCaptureStorageLocation object](#PacketCaptureStorageLocation) | -| filters | array | No | [PacketCaptureFilter object](#PacketCaptureFilter) | - - - -### PacketCaptureStorageLocation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageId | string | No | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | -| storagePath | string | No | 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. | -| filePath | string | No | 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. | - - - -### PacketCaptureFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol to be filtered on. - TCP, UDP, Any | -| localIPAddress | string | No | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | -| remoteIPAddress | string | No | 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 | No | 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. | -| remotePort | string | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-06-01/publicIPAddresses.md b/test/Resource/Expected/Network/2017-06-01/publicIPAddresses.md deleted file mode 100644 index 173cdd9..0000000 --- a/test/Resource/Expected/Network/2017-06-01/publicIPAddresses.md +++ /dev/null @@ -1,73 +0,0 @@ -# Microsoft.Network/publicIPAddresses template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/publicIPAddresses", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/publicIPAddresses object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/publicIPAddresses | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-06-01/routeFilters.md b/test/Resource/Expected/Network/2017-06-01/routeFilters.md deleted file mode 100644 index 5267505..0000000 --- a/test/Resource/Expected/Network/2017-06-01/routeFilters.md +++ /dev/null @@ -1,222 +0,0 @@ -# Microsoft.Network/routeFilters template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/routeFilters resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "RouteFilterPropertiesFormat" - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "RouteFilterPropertiesFormat" - }, - "state": "string" - } - }, - "name": "string" - } - ] - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | -| resources | array | No | [routeFilterRules](./routeFilters/routeFilterRules.md) | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - diff --git a/test/Resource/Expected/Network/2017-06-01/routeFilters/routeFilterRules.md b/test/Resource/Expected/Network/2017-06-01/routeFilters/routeFilterRules.md deleted file mode 100644 index c815884..0000000 --- a/test/Resource/Expected/Network/2017-06-01/routeFilters/routeFilterRules.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.Network/routeFilters/routeFilterRules template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/routeFilters/routeFilterRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters/routeFilterRules", - "apiVersion": "2017-06-01", - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters/routeFilterRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters/routeFilterRules | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-06-01/routeTables.md b/test/Resource/Expected/Network/2017-06-01/routeTables.md deleted file mode 100644 index 11bba7b..0000000 --- a/test/Resource/Expected/Network/2017-06-01/routeTables.md +++ /dev/null @@ -1,80 +0,0 @@ -# Microsoft.Network/routeTables template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/routeTables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [routes](./routeTables/routes.md) | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/routeTables/routes.md b/test/Resource/Expected/Network/2017-06-01/routeTables/routes.md deleted file mode 100644 index 754a390..0000000 --- a/test/Resource/Expected/Network/2017-06-01/routeTables/routes.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Network/routeTables/routes template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/routeTables/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables/routes", - "apiVersion": "2017-06-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables/routes | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/virtualNetworkGateways.md b/test/Resource/Expected/Network/2017-06-01/virtualNetworkGateways.md deleted file mode 100644 index e835b48..0000000 --- a/test/Resource/Expected/Network/2017-06-01/virtualNetworkGateways.md +++ /dev/null @@ -1,215 +0,0 @@ -# Microsoft.Network/virtualNetworkGateways template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/virtualNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworkGateways", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworkGateways | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway. - [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network gateway ip configuration. - [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | -| vpnClientProtocols | array | No | VpnClientProtocols for Virtual network gateway. - IkeV2 or SSTP | -| radiusServerAddress | string | No | The radius server address property of the VirtualNetworkGateway resource for vpn client connection. | -| radiusServerSecret | string | No | The radius secret property of the VirtualNetworkGateway resource for vpn client connection. | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the vpn client root certificate. - [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the vpn client revoked certificate. - [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-06-01/virtualNetworks.md b/test/Resource/Expected/Network/2017-06-01/virtualNetworks.md deleted file mode 100644 index d331955..0000000 --- a/test/Resource/Expected/Network/2017-06-01/virtualNetworks.md +++ /dev/null @@ -1,386 +0,0 @@ -# Microsoft.Network/virtualNetworks template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/virtualNetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks", - "apiVersion": "2017-06-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "addressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "string" - ] - }, - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "virtualNetworkPeerings": [ - { - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network. - [VirtualNetworkPropertiesFormat object](#VirtualNetworkPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [virtualNetworkPeerings](./virtualNetworks/virtualNetworkPeerings.md) [subnets](./virtualNetworks/subnets.md) | - - - -### VirtualNetworkPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressSpace | object | No | The AddressSpace that contains an array of IP address ranges that can be used by subnets. - [AddressSpace object](#AddressSpace) | -| dhcpOptions | object | No | The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. - [DhcpOptions object](#DhcpOptions) | -| subnets | array | No | A list of subnets in a Virtual Network. - [Subnet object](#Subnet) | -| virtualNetworkPeerings | array | No | A list of peerings in a Virtual Network. - [VirtualNetworkPeering object](#VirtualNetworkPeering) | -| resourceGuid | string | No | The resourceGuid property of the Virtual Network resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### DhcpOptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | The list of DNS servers IP addresses. - string | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network peering. - [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/virtualNetworks/subnets.md b/test/Resource/Expected/Network/2017-06-01/virtualNetworks/subnets.md deleted file mode 100644 index 1803db4..0000000 --- a/test/Resource/Expected/Network/2017-06-01/virtualNetworks/subnets.md +++ /dev/null @@ -1,275 +0,0 @@ -# Microsoft.Network/virtualNetworks/subnets template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/subnets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/subnets", - "apiVersion": "2017-06-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/subnets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/subnets | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-06-01/virtualNetworks/virtualNetworkPeerings.md b/test/Resource/Expected/Network/2017-06-01/virtualNetworks/virtualNetworkPeerings.md deleted file mode 100644 index 00da161..0000000 --- a/test/Resource/Expected/Network/2017-06-01/virtualNetworks/virtualNetworkPeerings.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/virtualNetworks/virtualNetworkPeerings template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/virtualNetworkPeerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings", - "apiVersion": "2017-06-01", - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/virtualNetworkPeerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/virtualNetworkPeerings | -| apiVersion | enum | Yes | 2017-06-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the virtual network peering. - [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - diff --git a/test/Resource/Expected/Network/2017-08-01/Microsoft.Network.json b/test/Resource/Expected/Network/2017-08-01/Microsoft.Network.json deleted file mode 100644 index b048586..0000000 --- a/test/Resource/Expected/Network/2017-08-01/Microsoft.Network.json +++ /dev/null @@ -1,7283 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-08-01/Microsoft.Network.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Network", - "description": "Microsoft Network Resource Types", - "resourceDefinitions": { - "applicationGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationGateways" - }, - "connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway connection." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/connections" - }, - "expressRouteCircuits": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/expressRouteCircuits_authorizations_childResource" - }, - { - "$ref": "#/definitions/expressRouteCircuits_peerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits" - }, - "expressRouteCircuits_authorizations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "loadBalancers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load balancer SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/loadBalancers_inboundNatRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers" - }, - "loadBalancers_inboundNatRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers/inboundNatRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers/inboundNatRules" - }, - "localNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/localNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the local network gateway." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/localNetworkGateways" - }, - "networkInterfaces": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkInterfaces" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network interface." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkInterfaces" - }, - "networkSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network security group" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkSecurityGroups_securityRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups" - }, - "networkSecurityGroups_securityRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups/securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "networkWatchers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkWatcherPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkWatchers_packetCaptures_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers" - }, - "networkWatchers_packetCaptures": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers/packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "publicIPAddresses": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/publicIPAddresses" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address properties." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/publicIPAddresses" - }, - "routeFilters": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeFilters_routeFilterRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters" - }, - "routeFilters_routeFilterRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters/routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "routeTables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route table." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeTables_routes_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables" - }, - "routeTables_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "virtualNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworkGateways" - }, - "virtualNetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualNetworks_subnets_childResource" - }, - { - "$ref": "#/definitions/virtualNetworks_virtualNetworkPeerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks" - }, - "virtualNetworks_subnets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - } - }, - "definitions": { - "AddressSpace": { - "type": "object", - "properties": { - "addressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of address blocks reserved for this virtual network in CIDR notation." - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." - }, - "ApplicationGatewayAuthenticationCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Authentication certificates of an application gateway." - }, - "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Certificate public data." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Authentication certificates properties of an application gateway." - }, - "ApplicationGatewayBackendAddress": { - "type": "object", - "properties": { - "fqdn": { - "type": "string", - "description": "Fully qualified domain name (FQDN)." - }, - "ipAddress": { - "type": "string", - "description": "IP address" - } - }, - "description": "Backend address of an application gateway." - }, - "ApplicationGatewayBackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of references to IPs defined in network interfaces." - }, - "backendAddresses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddress" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend addresses" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendHttpSettings": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Backend address pool settings of an application gateway." - }, - "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Port" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "cookieBasedAffinity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cookie based affinity." - }, - "requestTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probe resource of an application gateway." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of references to application gateway authentication certificates." - }, - "connectionDraining": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayConnectionDraining" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connection draining of the backend http settings resource." - }, - "hostName": { - "type": "string", - "description": "Host header to be sent to the backend servers." - }, - "pickHostNameFromBackendAddress": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." - }, - "affinityCookieName": { - "type": "string", - "description": "Cookie name to use for the affinity cookie." - }, - "probeEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the probe is enabled. Default value is false." - }, - "path": { - "type": "string", - "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend address pool settings of an application gateway." - }, - "ApplicationGatewayConnectionDraining": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether connection draining is enabled or not." - }, - "drainTimeoutInSec": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 3600 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." - } - }, - "required": [ - "enabled", - "drainTimeoutInSec" - ], - "description": "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." - }, - "ApplicationGatewayFirewallDisabledRuleGroup": { - "type": "object", - "properties": { - "ruleGroupName": { - "type": "string", - "description": "The name of the rule group that will be disabled." - }, - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." - } - }, - "required": [ - "ruleGroupName" - ], - "description": "Allows to disable rules within a rule group or an entire rule group." - }, - "ApplicationGatewayFrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "PrivateIPAddress of the network interface IP Configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PrivateIP allocation method." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the PublicIP resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendPort": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Frontend port of an application gateway." - }, - "ApplicationGatewayFrontendPortPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend port of an application gateway." - }, - "ApplicationGatewayHttpListener": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Http listener of an application gateway." - }, - "ApplicationGatewayHttpListenerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP configuration resource of an application gateway." - }, - "frontendPort": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of an application gateway." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "hostName": { - "type": "string", - "description": "Host name of HTTP listener." - }, - "sslCertificate": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificate resource of an application gateway." - }, - "requireServerNameIndication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of HTTP listener of an application gateway." - }, - "ApplicationGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." - }, - "ApplicationGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration of an application gateway." - }, - "ApplicationGatewayPathRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Path rule of URL path map of an application gateway." - }, - "ApplicationGatewayPathRulePropertiesFormat": { - "type": "object", - "properties": { - "paths": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules of URL path map." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of URL path map path rule." - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings resource of URL path map path rule." - }, - "redirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configuration resource of URL path map path rule." - }, - "provisioningState": { - "type": "string", - "description": "Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of path rule of an application gateway." - }, - "ApplicationGatewayProbe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Probe of the application gateway." - }, - "ApplicationGatewayProbeHealthResponseMatch": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "Body that must be contained in the health response. Default value is empty." - }, - "statusCodes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." - } - }, - "description": "Application gateway probe health response match" - }, - "ApplicationGatewayProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "host": { - "type": "string", - "description": "Host name to send the probe to." - }, - "path": { - "type": "string", - "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:" - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." - }, - "timeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." - }, - "pickHostNameFromBackendHttpSettings": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the host header should be picked from the backend http settings. Default value is false." - }, - "minServers": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum number of servers that are always marked healthy. Default value is 0." - }, - "match": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Criterion for classifying a healthy probe response." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayPropertiesFormat": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU of the application gateway resource." - }, - "sslPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL policy of the application gateway resource." - }, - "gatewayIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnets of application the gateway resource." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Authentication certificates of the application gateway resource." - }, - "sslCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewaySslCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificates of the application gateway resource." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP addresses of the application gateway resource." - }, - "frontendPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendPort" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend ports of the application gateway resource." - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayProbe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probes of the application gateway resource." - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool of the application gateway resource." - }, - "backendHttpSettingsCollection": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings of the application gateway resource." - }, - "httpListeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayHttpListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listeners of the application gateway resource." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayUrlPathMap" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map of the application gateway resource." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing rules of the application gateway resource." - }, - "redirectConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configurations of the application gateway resource." - }, - "webApplicationFirewallConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall configuration." - }, - "resourceGuid": { - "type": "string", - "description": "Resource GUID property of the application gateway resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the application gateway." - }, - "ApplicationGatewayRedirectConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Redirect configuration of an application gateway." - }, - "ApplicationGatewayRedirectConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "redirectType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Permanent", - "Found", - "SeeOther", - "Temporary" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Supported http redirection types - Permanent, Temporary, Found, SeeOther." - }, - "targetListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference to a listener to redirect the request to." - }, - "targetUrl": { - "type": "string", - "description": "Url to redirect the request to." - }, - "includePath": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Include path in the redirected url." - }, - "includeQueryString": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Include query string in the redirected url." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing specifying redirect configuration." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Url path maps specifying default redirect configuration." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules specifying redirect configuration." - } - }, - "description": "Properties of redirect configuration of the application gateway." - }, - "ApplicationGatewayRequestRoutingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Request routing rule of an application gateway." - }, - "ApplicationGatewayRequestRoutingRulePropertiesFormat": { - "type": "object", - "properties": { - "ruleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "PathBasedRouting" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Rule type." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of the application gateway. " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of the application gateway." - }, - "httpListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listener resource of the application gateway. " - }, - "urlPathMap": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map resource of the application gateway." - }, - "redirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configuration resource of the application gateway." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of request routing rule of the application gateway." - }, - "ApplicationGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_Small", - "Standard_Medium", - "Standard_Large", - "WAF_Medium", - "WAF_Large" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of an application gateway SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "WAF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tier of an application gateway." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity (instance count) of an application gateway." - } - }, - "description": "SKU of an application gateway" - }, - "ApplicationGatewaySslCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "SSL certificates of an application gateway." - }, - "ApplicationGatewaySslCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." - }, - "password": { - "type": "string", - "description": "Password for the pfx file specified in data. Only applicable in PUT request." - }, - "publicCertData": { - "type": "string", - "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of SSL certificates of an application gateway." - }, - "ApplicationGatewaySslPolicy": { - "type": "object", - "properties": { - "disabledSslProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ssl protocols to be disabled on application gateway." - }, - "policyType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Predefined", - "Custom" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of Ssl Policy." - }, - "policyName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AppGwSslPolicy20150501", - "AppGwSslPolicy20170401", - "AppGwSslPolicy20170401S" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of Ssl predefined policy." - }, - "cipherSuites": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", - "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", - "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", - "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", - "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", - "TLS_RSA_WITH_AES_256_GCM_SHA384", - "TLS_RSA_WITH_AES_128_GCM_SHA256", - "TLS_RSA_WITH_AES_256_CBC_SHA256", - "TLS_RSA_WITH_AES_128_CBC_SHA256", - "TLS_RSA_WITH_AES_256_CBC_SHA", - "TLS_RSA_WITH_AES_128_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", - "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", - "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", - "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", - "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", - "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", - "TLS_RSA_WITH_3DES_EDE_CBC_SHA" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ssl cipher suites to be enabled in the specified order to application gateway." - }, - "minProtocolVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum version of Ssl protocol to be supported on application gateway." - } - }, - "description": "Application Gateway Ssl policy." - }, - "ApplicationGatewayUrlPathMap": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." - }, - "ApplicationGatewayUrlPathMapPropertiesFormat": { - "type": "object", - "properties": { - "defaultBackendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend address pool resource of URL path map." - }, - "defaultBackendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend http settings resource of URL path map." - }, - "defaultRedirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default redirect configuration resource of URL path map." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayPathRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rule of URL path map resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of UrlPathMap of the application gateway." - }, - "ApplicationGatewayWebApplicationFirewallConfiguration": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the web application firewall is enabled or not." - }, - "firewallMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Detection", - "Prevention" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall mode." - }, - "ruleSetType": { - "type": "string", - "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." - }, - "ruleSetVersion": { - "type": "string", - "description": "The version of the rule set type." - }, - "disabledRuleGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The disabled rule groups." - } - }, - "required": [ - "enabled", - "firewallMode", - "ruleSetType", - "ruleSetVersion" - ], - "description": "Application gateway web application firewall configuration." - }, - "AuthorizationPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorization key." - }, - "authorizationUseStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Available", - "InUse" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "BackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer backend address pool." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Pool of backend IP addresses." - }, - "BackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "description": "Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the backend address pool." - }, - "BgpSettings": { - "type": "object", - "properties": { - "asn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BGP speaker's ASN." - }, - "bgpPeeringAddress": { - "type": "string", - "description": "The BGP peering address and BGP identifier of this BGP speaker." - }, - "peerWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The weight added to routes learned from this BGP speaker." - } - }, - "description": "BGP settings details" - }, - "DhcpOptions": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of DNS servers IP addresses." - } - }, - "description": "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." - }, - "ExpressRouteCircuitAuthorization": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Authorization in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Peering in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "advertisedPublicPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of AdvertisedPublicPrefixes." - }, - "advertisedCommunities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The communities of bgp peering. Spepcified for microsoft peering" - }, - "advertisedPublicPrefixesState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotConfigured", - "Configuring", - "Configured", - "ValidationNeeded" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'." - }, - "legacyMode": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The legacy mode of the peering." - }, - "customerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CustomerASN of the peering." - }, - "routingRegistryName": { - "type": "string", - "description": "The RoutingRegistryName of the configuration." - } - }, - "description": "Specifies the peering configuration." - }, - "ExpressRouteCircuitPeeringPropertiesFormat": { - "type": "object", - "properties": { - "peeringType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzurePublicPeering", - "AzurePrivatePeering", - "MicrosoftPeering" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - }, - "azureASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Azure ASN." - }, - "peerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The peer ASN." - }, - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "primaryAzurePort": { - "type": "string", - "description": "The primary port." - }, - "secondaryAzurePort": { - "type": "string", - "description": "The secondary port." - }, - "sharedKey": { - "type": "string", - "description": "The shared key." - }, - "vlanId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The VLAN ID." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "stats": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitStats" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets peering stats." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets whether the provider or the customer last modified the peering." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "ipv6PeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPv6 peering configuration." - } - } - }, - "ExpressRouteCircuitPropertiesFormat": { - "type": "object", - "properties": { - "allowClassicOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allow classic operations" - }, - "circuitProvisioningState": { - "type": "string", - "description": "The CircuitProvisioningState state of the resource." - }, - "serviceProviderProvisioningState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotProvisioned", - "Provisioning", - "Provisioned", - "Deprovisioning" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'." - }, - "authorizations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitAuthorization" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of authorizations." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of peerings." - }, - "serviceKey": { - "type": "string", - "description": "The ServiceKey." - }, - "serviceProviderNotes": { - "type": "string", - "description": "The ServiceProviderNotes." - }, - "serviceProviderProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProperties." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - } - }, - "description": "Properties of ExpressRouteCircuit." - }, - "ExpressRouteCircuitServiceProviderProperties": { - "type": "object", - "properties": { - "serviceProviderName": { - "type": "string", - "description": "The serviceProviderName." - }, - "peeringLocation": { - "type": "string", - "description": "The peering location." - }, - "bandwidthInMbps": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BandwidthInMbps." - } - }, - "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tier of the SKU. Possible values are 'Standard' and 'Premium'." - }, - "family": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UnlimitedData", - "MeteredData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'." - } - }, - "description": "Contains SKU in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitStats": { - "type": "object", - "properties": { - "primarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "primarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - }, - "secondarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "secondarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - } - }, - "description": "Contains stats associated with the peering." - }, - "expressRouteCircuits_authorizations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "FrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the load balancer probe." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "description": "Frontend IP address of the load balancer." - }, - "FrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "The private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the Public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP Configuration of the load balancer." - }, - "InboundNatPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat pool." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT pool of the load balancer." - }, - "InboundNatPoolPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPortRangeStart", - "frontendPortRangeEnd", - "backendPort" - ], - "description": "Properties of Inbound NAT pool." - }, - "InboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT rule of the load balancer." - }, - "InboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the inbound NAT rule." - }, - "IpsecPolicy": { - "type": "object", - "properties": { - "saLifeTimeSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." - }, - "saDataSizeKilobytes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." - }, - "ipsecEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DES", - "DES3", - "AES128", - "AES192", - "AES256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec encryption algorithm (IKE phase 1)." - }, - "ipsecIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec integrity algorithm (IKE phase 1)." - }, - "ikeEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "DES", - "DES3", - "AES128", - "AES192", - "AES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE encryption algorithm (IKE phase 2)." - }, - "ikeIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "SHA384" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE integrity algorithm (IKE phase 2)." - }, - "dhGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DHGroup1", - "DHGroup2", - "DHGroup14", - "DHGroup2048", - "ECP256", - "ECP384", - "DHGroup24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 1 for initial SA." - }, - "pfsGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "PFS1", - "PFS2", - "PFS2048", - "ECP256", - "ECP384", - "PFS24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 2 for new child SA." - } - }, - "required": [ - "saLifeTimeSeconds", - "saDataSizeKilobytes", - "ipsecEncryption", - "ipsecIntegrity", - "ikeEncryption", - "ikeIntegrity", - "dhGroup", - "pfsGroup" - ], - "description": "An IPSec Policy configuration for a virtual network gateway connection" - }, - "Ipv6ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - } - }, - "description": "Contains IPv6 peering config." - }, - "LoadBalancerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/FrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object representing the frontend IPs to be used for the load balancer" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of backend address pools used by a load balancer" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object collection representing the load balancing rules Gets the provisioning " - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Probe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of probe objects used in the load balancer" - }, - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/OutboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The outbound NAT rules." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the load balancer resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the load balancer." - }, - "LoadBalancerSku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of a load balancer SKU." - } - }, - "description": "SKU of a load balancer" - }, - "loadBalancers_inboundNatRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "inboundNatRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers/inboundNatRules" - }, - "LoadBalancingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer load balancing rule." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancing rule for a load balancer." - }, - "LoadBalancingRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the load balancer probe used by the load balancing rule." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'." - }, - "loadDistribution": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "SourceIP", - "SourceIPProtocol" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. " - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "disableOutboundSnat": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPort" - ], - "description": "Properties of the load balancer." - }, - "LocalNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the local network gateway." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "LocalNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "localNetworkAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network site address space." - }, - "gatewayIpAddress": { - "type": "string", - "description": "IP address of local network gateway." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the LocalNetworkGateway resource." - } - }, - "description": "LocalNetworkGateway properties" - }, - "NetworkInterfaceDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "appliedDnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "internalDnsNameLabel": { - "type": "string", - "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." - }, - "internalFqdn": { - "type": "string", - "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." - }, - "internalDomainNameSuffix": { - "type": "string", - "description": "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." - } - }, - "description": "DNS settings of a network interface." - }, - "NetworkInterfaceIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network interface IP configuration properties." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IPConfiguration in a network interface." - }, - "NetworkInterfaceIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of ApplicationGatewayBackendAddressPool resource." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of LoadBalancerBackendAddressPool resource." - }, - "loadBalancerInboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references of LoadBalancerInboundNatRules." - }, - "privateIPAddress": { - "type": "string", - "description": "Private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnet bound to the IP configuration." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary customer address on the network interface." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address bound to the IP configuration." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration." - }, - "NetworkInterfacePropertiesFormat": { - "type": "object", - "properties": { - "virtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of a virtual machine." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of IPConfigurations of the network interface." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DNS settings in network interface." - }, - "macAddress": { - "type": "string", - "description": "The MAC address of the network interface." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary network interface on a virtual machine." - }, - "enableAcceleratedNetworking": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the network interface is accelerated networking enabled." - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether IP forwarding is enabled on this network interface." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network interface resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "NetworkInterface properties. " - }, - "NetworkSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network security group" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "NetworkSecurityGroup resource." - }, - "NetworkSecurityGroupPropertiesFormat": { - "type": "object", - "properties": { - "securityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of security rules of the network security group." - }, - "defaultSecurityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The default security rules of network security group." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network security group resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Network Security Group resource." - }, - "networkSecurityGroups_securityRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "NetworkWatcherPropertiesFormat": { - "type": "object", - "properties": {}, - "description": "The network watcher properties." - }, - "networkWatchers_packetCaptures_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "OutboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OutboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer outbound nat rule." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Outbound NAT pool of the load balancer." - }, - "OutboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "allocatedOutboundPorts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of outbound ports to be used for NAT." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Frontend IP addresses of the load balancer." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "backendAddressPool" - ], - "description": "Outbound NAT pool of the load balancer." - }, - "PacketCaptureFilter": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TCP", - "UDP", - "Any" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol to be filtered on." - }, - "localIPAddress": { - "type": "string", - "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." - }, - "remoteIPAddress": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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." - }, - "remotePort": { - "type": "string", - "description": "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." - } - }, - "description": "Filter that is applied to packet capture request. Multiple filters can be applied." - }, - "PacketCaptureParameters": { - "type": "object", - "properties": { - "target": { - "type": "string", - "description": "The ID of the targeted resource, only VM is currently supported." - }, - "bytesToCapturePerPacket": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of bytes captured per packet, the remaining bytes are truncated." - }, - "totalBytesPerSession": { - "oneOf": [ - { - "type": "integer", - "default": "1073741824" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum size of the capture output." - }, - "timeLimitInSeconds": { - "oneOf": [ - { - "type": "integer", - "default": "18000" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum duration of the capture session in seconds." - }, - "storageLocation": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureStorageLocation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "filters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PacketCaptureFilter" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "target", - "storageLocation" - ], - "description": "Parameters that define the create packet capture operation." - }, - "PacketCaptureStorageLocation": { - "type": "object", - "properties": { - "storageId": { - "type": "string", - "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." - }, - "storagePath": { - "type": "string", - "description": "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." - }, - "filePath": { - "type": "string", - "description": "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." - } - }, - "description": "Describes the storage location for a packet capture session." - }, - "Probe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer probe." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancer probe." - }, - "ProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." - }, - "intervalInSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "numberOfProbes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "requestPath": { - "type": "string", - "description": "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." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "port" - ], - "description": "Load balancer probe resource." - }, - "PublicIPAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address properties." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "description": "Public IP address resource." - }, - "PublicIPAddressDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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. " - } - }, - "description": "Contains FQDN of the DNS record associated with the public IP address" - }, - "PublicIPAddressPropertiesFormat": { - "type": "object", - "properties": { - "publicIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "publicIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The FQDN of the DNS record associated with the public IP address." - }, - "ipAddress": { - "type": "string", - "description": "The IP address associated with the public IP address resource." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The idle timeout of the public IP address." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Public IP address properties." - }, - "PublicIPAddressSku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of a public IP address SKU." - } - }, - "description": "SKU of a public IP address" - }, - "ResourceNavigationLink": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceNavigationLinkFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource navigation link properties format." - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "ResourceNavigationLink resource." - }, - "ResourceNavigationLinkFormat": { - "type": "object", - "properties": { - "linkedResourceType": { - "type": "string", - "description": "Resource type of the linked resource." - }, - "link": { - "type": "string", - "description": "Link to the external resource" - } - }, - "description": "Properties of ResourceNavigationLink." - }, - "Route": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route resource" - }, - "RouteFilter": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Route Filter Resource." - }, - "RouteFilterPropertiesFormat": { - "type": "object", - "properties": { - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RouteFilterRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of RouteFilterRules contained within a route filter." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of references to express route circuit peerings." - } - }, - "description": "Route Filter Resource" - }, - "RouteFilterRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "description": "Route Filter Rule Resource" - }, - "RouteFilterRulePropertiesFormat": { - "type": "object", - "properties": { - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The access type of the rule. Valid values are: 'Allow', 'Deny'." - }, - "routeFilterRuleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Community" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The rule type of the rule. Valid value is: 'Community'" - }, - "communities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']" - } - }, - "required": [ - "access", - "routeFilterRuleType", - "communities" - ], - "description": "Route Filter Rule Resource" - }, - "routeFilters_routeFilterRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "RoutePropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The destination CIDR to which the route applies." - }, - "nextHopType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VirtualNetworkGateway", - "VnetLocal", - "Internet", - "VirtualAppliance", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'." - }, - "nextHopIpAddress": { - "type": "string", - "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "nextHopType" - ], - "description": "Route resource" - }, - "RouteTable": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route table." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route table resource." - }, - "RouteTablePropertiesFormat": { - "type": "object", - "properties": { - "routes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Route" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of routes contained within a route table." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Route Table resource" - }, - "routeTables_routes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "SecurityRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Network security rule." - }, - "SecurityRulePropertiesFormat": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description for this rule. Restricted to 140 chars." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp", - "*" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'." - }, - "sourcePortRange": { - "type": "string", - "description": "The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "destinationPortRange": { - "type": "string", - "description": "The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "sourceAddressPrefix": { - "type": "string", - "description": "The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " - }, - "sourceAddressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CIDR or source IP ranges." - }, - "destinationAddressPrefix": { - "type": "string", - "description": "The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." - }, - "destinationAddressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The destination address prefixes. CIDR or destination IP ranges." - }, - "sourcePortRanges": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source port ranges." - }, - "destinationPortRanges": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The destination port ranges." - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'." - }, - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "access", - "direction" - ], - "description": "Security rule resource." - }, - "ServiceEndpointPropertiesFormat": { - "type": "object", - "properties": { - "service": { - "type": "string", - "description": "The type of the endpoint service." - }, - "locations": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of locations." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "The service endpoint properties." - }, - "Subnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Subnet in a virtual network resource." - }, - "SubnetPropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The address prefix for the subnet." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "routeTable": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTable" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteTable resource." - }, - "serviceEndpoints": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceEndpointPropertiesFormat" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An array of service endpoints." - }, - "resourceNavigationLinks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceNavigationLink" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets an array of references to the external resources using subnet." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "Properties of the subnet." - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - } - }, - "description": "Reference to another subresource." - }, - "VirtualNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "VirtualNetworkGatewayConnectionPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorizationKey." - }, - "virtualNetworkGateway1": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to virtual network gateway resource." - }, - "virtualNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to virtual network gateway resource." - }, - "localNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to local network gateway resource." - }, - "connectionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPsec", - "Vnet2Vnet", - "ExpressRoute", - "VPNClient" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient." - }, - "routingWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The routing weight." - }, - "sharedKey": { - "type": "string", - "description": "The IPSec shared key." - }, - "peer": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to peerings resource." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp flag" - }, - "usePolicyBasedTrafficSelectors": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Enable policy-based traffic selectors." - }, - "ipsecPolicies": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IpsecPolicy" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Policies to be considered by this connection." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." - } - }, - "required": [ - "virtualNetworkGateway1", - "connectionType" - ], - "description": "VirtualNetworkGatewayConnection properties" - }, - "VirtualNetworkGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway ip configuration." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration for virtual network gateway" - }, - "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the public IP resource." - } - }, - "description": "Properties of VirtualNetworkGatewayIPConfiguration" - }, - "VirtualNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IP configurations for virtual network gateway." - }, - "gatewayType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Vpn", - "ExpressRoute" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PolicyBased", - "RouteBased" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether BGP is enabled for this virtual network gateway or not." - }, - "activeActive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "ActiveActive flag" - }, - "gatewayDefaultSite": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." - }, - "vpnClientConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGateway resource." - } - }, - "description": "VirtualNetworkGateway properties" - }, - "VirtualNetworkGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU name." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU tier." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity." - } - }, - "description": "VirtualNetworkGatewaySku details" - }, - "VirtualNetworkPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Peerings in a virtual network resource." - }, - "VirtualNetworkPeeringPropertiesFormat": { - "type": "object", - "properties": { - "allowVirtualNetworkAccess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space." - }, - "allowForwardedTraffic": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed." - }, - "allowGatewayTransit": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If gateway links can be used in remote virtual networking to link to this virtual network." - }, - "useRemoteGateways": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "remoteVirtualNetwork": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the remote virtual network." - }, - "peeringState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Initiated", - "Connected", - "Disconnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "Properties of the virtual network peering." - }, - "VirtualNetworkPropertiesFormat": { - "type": "object", - "properties": { - "addressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." - }, - "dhcpOptions": { - "oneOf": [ - { - "$ref": "#/definitions/DhcpOptions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of subnets in a Virtual Network." - }, - "virtualNetworkPeerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of peerings in a Virtual Network." - }, - "resourceGuid": { - "type": "string", - "description": "The resourceGuid property of the Virtual Network resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the virtual network." - }, - "virtualNetworks_subnets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-08-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - }, - "VpnClientConfiguration": { - "type": "object", - "properties": { - "vpnClientAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the address space resource which represents Address space for P2S VpnClient." - }, - "vpnClientRootCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRootCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRootCertificate for virtual network gateway." - }, - "vpnClientRevokedCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRevokedCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRevokedCertificate for Virtual network gateway." - }, - "vpnClientProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "IkeV2", - "SSTP" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientProtocols for Virtual network gateway." - }, - "radiusServerAddress": { - "type": "string", - "description": "The radius server address property of the VirtualNetworkGateway resource for vpn client connection." - }, - "radiusServerSecret": { - "type": "string", - "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection." - } - }, - "description": "VpnClientConfiguration for P2S client." - }, - "VpnClientRevokedCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the vpn client revoked certificate." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "VPN client revoked certificate of virtual network gateway." - }, - "VpnClientRevokedCertificatePropertiesFormat": { - "type": "object", - "properties": { - "thumbprint": { - "type": "string", - "description": "The revoked VPN client certificate thumbprint." - } - }, - "description": "Properties of the revoked VPN client certificate of virtual network gateway." - }, - "VpnClientRootCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the vpn client root certificate." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "VPN client root certificate of virtual network gateway" - }, - "VpnClientRootCertificatePropertiesFormat": { - "type": "object", - "properties": { - "publicCertData": { - "type": "string", - "description": "The certificate public data." - } - }, - "required": [ - "publicCertData" - ], - "description": "Properties of SSL certificates of application gateway" - } - } -} diff --git a/test/Resource/Expected/Network/2017-08-01/applicationGateways.md b/test/Resource/Expected/Network/2017-08-01/applicationGateways.md deleted file mode 100644 index e690bfd..0000000 --- a/test/Resource/Expected/Network/2017-08-01/applicationGateways.md +++ /dev/null @@ -1,1163 +0,0 @@ -# Microsoft.Network/applicationGateways template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/applicationGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationGateways", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "sslPolicy": { - "disabledSslProtocols": [ - "string" - ], - "policyType": "string", - "policyName": "string", - "cipherSuites": [ - "string" - ], - "minProtocolVersion": "string" - }, - "gatewayIPConfigurations": [ - { - "id": "string", - "properties": { - "subnet": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "authenticationCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "sslCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "password": "string", - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "frontendPorts": [ - { - "id": "string", - "properties": { - "port": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "host": "string", - "path": "string", - "interval": "integer", - "timeout": "integer", - "unhealthyThreshold": "integer", - "pickHostNameFromBackendHttpSettings": "boolean", - "minServers": "integer", - "match": { - "body": "string", - "statusCodes": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - "ApplicationGatewayBackendAddressPool" - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "backendHttpSettingsCollection": [ - { - "id": "string", - "properties": { - "port": "integer", - "protocol": "string", - "cookieBasedAffinity": "string", - "requestTimeout": "integer", - "probe": { - "id": "string" - }, - "authenticationCertificates": [ - { - "id": "string" - } - ], - "connectionDraining": { - "enabled": "boolean", - "drainTimeoutInSec": "integer" - }, - "hostName": "string", - "pickHostNameFromBackendAddress": "boolean", - "affinityCookieName": "string", - "probeEnabled": "boolean", - "path": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "httpListeners": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "frontendPort": { - "id": "string" - }, - "protocol": "string", - "hostName": "string", - "sslCertificate": { - "id": "string" - }, - "requireServerNameIndication": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "urlPathMaps": [ - { - "id": "string", - "properties": { - "defaultBackendAddressPool": { - "id": "string" - }, - "defaultBackendHttpSettings": { - "id": "string" - }, - "defaultRedirectConfiguration": { - "id": "string" - }, - "pathRules": [ - { - "id": "string", - "properties": { - "paths": [ - "string" - ], - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "redirectConfiguration": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "requestRoutingRules": [ - { - "id": "string", - "properties": { - "ruleType": "string", - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "httpListener": { - "id": "string" - }, - "urlPathMap": { - "id": "string" - }, - "redirectConfiguration": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "redirectConfigurations": [ - { - "id": "string", - "properties": { - "redirectType": "string", - "targetListener": { - "id": "string" - }, - "targetUrl": "string", - "includePath": "boolean", - "includeQueryString": "boolean", - "requestRoutingRules": [ - { - "id": "string" - } - ], - "urlPathMaps": [ - { - "id": "string" - } - ], - "pathRules": [ - { - "id": "string" - } - ] - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "webApplicationFirewallConfiguration": { - "enabled": "boolean", - "firewallMode": "string", - "ruleSetType": "string", - "ruleSetVersion": "string", - "disabledRuleGroups": [ - { - "ruleGroupName": "string", - "rules": [ - "integer" - ] - } - ] - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationGateways | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [ApplicationGatewayPropertiesFormat object](#ApplicationGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | SKU of the application gateway resource. - [ApplicationGatewaySku object](#ApplicationGatewaySku) | -| sslPolicy | object | No | SSL policy of the application gateway resource. - [ApplicationGatewaySslPolicy object](#ApplicationGatewaySslPolicy) | -| gatewayIPConfigurations | array | No | Subnets of application the gateway resource. - [ApplicationGatewayIPConfiguration object](#ApplicationGatewayIPConfiguration) | -| authenticationCertificates | array | No | Authentication certificates of the application gateway resource. - [ApplicationGatewayAuthenticationCertificate object](#ApplicationGatewayAuthenticationCertificate) | -| sslCertificates | array | No | SSL certificates of the application gateway resource. - [ApplicationGatewaySslCertificate object](#ApplicationGatewaySslCertificate) | -| frontendIPConfigurations | array | No | Frontend IP addresses of the application gateway resource. - [ApplicationGatewayFrontendIPConfiguration object](#ApplicationGatewayFrontendIPConfiguration) | -| frontendPorts | array | No | Frontend ports of the application gateway resource. - [ApplicationGatewayFrontendPort object](#ApplicationGatewayFrontendPort) | -| probes | array | No | Probes of the application gateway resource. - [ApplicationGatewayProbe object](#ApplicationGatewayProbe) | -| backendAddressPools | array | No | Backend address pool of the application gateway resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| backendHttpSettingsCollection | array | No | Backend http settings of the application gateway resource. - [ApplicationGatewayBackendHttpSettings object](#ApplicationGatewayBackendHttpSettings) | -| httpListeners | array | No | Http listeners of the application gateway resource. - [ApplicationGatewayHttpListener object](#ApplicationGatewayHttpListener) | -| urlPathMaps | array | No | URL path map of the application gateway resource. - [ApplicationGatewayUrlPathMap object](#ApplicationGatewayUrlPathMap) | -| requestRoutingRules | array | No | Request routing rules of the application gateway resource. - [ApplicationGatewayRequestRoutingRule object](#ApplicationGatewayRequestRoutingRule) | -| redirectConfigurations | array | No | Redirect configurations of the application gateway resource. - [ApplicationGatewayRedirectConfiguration object](#ApplicationGatewayRedirectConfiguration) | -| webApplicationFirewallConfiguration | object | No | Web application firewall configuration. - [ApplicationGatewayWebApplicationFirewallConfiguration object](#ApplicationGatewayWebApplicationFirewallConfiguration) | -| resourceGuid | string | No | Resource GUID property of the application gateway resource. | -| provisioningState | string | No | Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of an application gateway SKU. - Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large | -| tier | enum | No | Tier of an application gateway. - Standard or WAF | -| capacity | integer | No | Capacity (instance count) of an application gateway. | - - - -### ApplicationGatewaySslPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disabledSslProtocols | array | No | Ssl protocols to be disabled on application gateway. - TLSv1_0, TLSv1_1, TLSv1_2 | -| policyType | enum | No | Type of Ssl Policy. - Predefined or Custom | -| policyName | enum | No | Name of Ssl predefined policy. - AppGwSslPolicy20150501, AppGwSslPolicy20170401, AppGwSslPolicy20170401S | -| cipherSuites | array | No | Ssl cipher suites to be enabled in the specified order to application gateway. - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA | -| minProtocolVersion | enum | No | Minimum version of Ssl protocol to be supported on application gateway. - TLSv1_0, TLSv1_1, TLSv1_2 | - - - -### ApplicationGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayIPConfigurationPropertiesFormat object](#ApplicationGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayAuthenticationCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayAuthenticationCertificatePropertiesFormat object](#ApplicationGatewayAuthenticationCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewaySslCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewaySslCertificatePropertiesFormat object](#ApplicationGatewaySslCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayFrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendIPConfigurationPropertiesFormat object](#ApplicationGatewayFrontendIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayFrontendPort object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendPortPropertiesFormat object](#ApplicationGatewayFrontendPortPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayProbe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayProbePropertiesFormat object](#ApplicationGatewayProbePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayBackendHttpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendHttpSettingsPropertiesFormat object](#ApplicationGatewayBackendHttpSettingsPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayHttpListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayHttpListenerPropertiesFormat object](#ApplicationGatewayHttpListenerPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayUrlPathMap object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayUrlPathMapPropertiesFormat object](#ApplicationGatewayUrlPathMapPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayRequestRoutingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRequestRoutingRulePropertiesFormat object](#ApplicationGatewayRequestRoutingRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayRedirectConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRedirectConfigurationPropertiesFormat object](#ApplicationGatewayRedirectConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayWebApplicationFirewallConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether the web application firewall is enabled or not. | -| firewallMode | enum | Yes | Web application firewall mode. - Detection or Prevention | -| ruleSetType | string | Yes | The type of the web application firewall rule set. Possible values are: 'OWASP'. | -| ruleSetVersion | string | Yes | The version of the rule set type. | -| disabledRuleGroups | array | No | The disabled rule groups. - [ApplicationGatewayFirewallDisabledRuleGroup object](#ApplicationGatewayFirewallDisabledRuleGroup) | - - - -### ApplicationGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Reference of the subnet resource. A subnet from where application gateway gets its private address. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayAuthenticationCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Certificate public data. | -| provisioningState | string | No | Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySslCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Base-64 encoded pfx certificate. Only applicable in PUT Request. | -| password | string | No | Password for the pfx file specified in data. Only applicable in PUT request. | -| publicCertData | string | No | Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. | -| provisioningState | string | No | Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | PrivateIPAddress of the network interface IP Configuration. | -| privateIPAllocationMethod | enum | No | PrivateIP allocation method. - Static or Dynamic | -| subnet | object | No | Reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Reference of the PublicIP resource. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendPortPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Frontend port | -| provisioningState | string | No | Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol. - Http or Https | -| host | string | No | Host name to send the probe to. | -| path | string | No | Relative path of probe. Valid path starts from '/'. Probe is sent to ://: | -| interval | integer | No | The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. | -| timeout | integer | No | 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 | integer | No | The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. | -| pickHostNameFromBackendHttpSettings | boolean | No | Whether the host header should be picked from the backend http settings. Default value is false. | -| minServers | integer | No | Minimum number of servers that are always marked healthy. Default value is 0. | -| match | object | No | Criterion for classifying a healthy probe response. - [ApplicationGatewayProbeHealthResponseMatch object](#ApplicationGatewayProbeHealthResponseMatch) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendHttpSettingsPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Port | -| protocol | enum | No | Protocol. - Http or Https | -| cookieBasedAffinity | enum | No | Cookie based affinity. - Enabled or Disabled | -| requestTimeout | integer | No | 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. | -| probe | object | No | Probe resource of an application gateway. - [SubResource object](#SubResource) | -| authenticationCertificates | array | No | Array of references to application gateway authentication certificates. - [SubResource object](#SubResource) | -| connectionDraining | object | No | Connection draining of the backend http settings resource. - [ApplicationGatewayConnectionDraining object](#ApplicationGatewayConnectionDraining) | -| hostName | string | No | Host header to be sent to the backend servers. | -| pickHostNameFromBackendAddress | boolean | No | Whether to pick host header should be picked from the host name of the backend server. Default value is false. | -| affinityCookieName | string | No | Cookie name to use for the affinity cookie. | -| probeEnabled | boolean | No | Whether the probe is enabled. Default value is false. | -| path | string | No | Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayHttpListenerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Frontend IP configuration resource of an application gateway. - [SubResource object](#SubResource) | -| frontendPort | object | No | Frontend port resource of an application gateway. - [SubResource object](#SubResource) | -| protocol | enum | No | Protocol. - Http or Https | -| hostName | string | No | Host name of HTTP listener. | -| sslCertificate | object | No | SSL certificate resource of an application gateway. - [SubResource object](#SubResource) | -| requireServerNameIndication | boolean | No | Applicable only if protocol is https. Enables SNI for multi-hosting. | -| provisioningState | string | No | Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayUrlPathMapPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultBackendAddressPool | object | No | Default backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| defaultBackendHttpSettings | object | No | Default backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| defaultRedirectConfiguration | object | No | Default redirect configuration resource of URL path map. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rule of URL path map resource. - [ApplicationGatewayPathRule object](#ApplicationGatewayPathRule) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRequestRoutingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleType | enum | No | Rule type. - Basic or PathBasedRouting | -| backendAddressPool | object | No | Backend address pool resource of the application gateway. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Frontend port resource of the application gateway. - [SubResource object](#SubResource) | -| httpListener | object | No | Http listener resource of the application gateway. - [SubResource object](#SubResource) | -| urlPathMap | object | No | URL path map resource of the application gateway. - [SubResource object](#SubResource) | -| redirectConfiguration | object | No | Redirect configuration resource of the application gateway. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRedirectConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| redirectType | enum | No | Supported http redirection types - Permanent, Temporary, Found, SeeOther. - Permanent, Found, SeeOther, Temporary | -| targetListener | object | No | Reference to a listener to redirect the request to. - [SubResource object](#SubResource) | -| targetUrl | string | No | Url to redirect the request to. | -| includePath | boolean | No | Include path in the redirected url. | -| includeQueryString | boolean | No | Include query string in the redirected url. | -| requestRoutingRules | array | No | Request routing specifying redirect configuration. - [SubResource object](#SubResource) | -| urlPathMaps | array | No | Url path maps specifying default redirect configuration. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rules specifying redirect configuration. - [SubResource object](#SubResource) | - - - -### ApplicationGatewayFirewallDisabledRuleGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleGroupName | string | Yes | The name of the rule group that will be disabled. | -| rules | array | No | The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - integer | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### ApplicationGatewayProbeHealthResponseMatch object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| body | string | No | Body that must be contained in the health response. Default value is empty. | -| statusCodes | array | No | Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - string | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Network interface IP configuration properties. - [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### ApplicationGatewayConnectionDraining object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether connection draining is enabled or not. | -| drainTimeoutInSec | integer | Yes | The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. | - - - -### ApplicationGatewayPathRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayPathRulePropertiesFormat object](#ApplicationGatewayPathRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | Private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | Subnet bound to the IP configuration. - [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | Public IP address bound to the IP configuration. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayPathRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| paths | array | No | Path rules of URL path map. - string | -| backendAddressPool | object | No | Backend address pool resource of URL path map path rule. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Backend http settings resource of URL path map path rule. - [SubResource object](#SubResource) | -| redirectConfiguration | object | No | Redirect configuration resource of URL path map path rule. - [SubResource object](#SubResource) | -| provisioningState | string | No | Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/connections.md b/test/Resource/Expected/Network/2017-08-01/connections.md deleted file mode 100644 index beb3827..0000000 --- a/test/Resource/Expected/Network/2017-08-01/connections.md +++ /dev/null @@ -1,403 +0,0 @@ -# Microsoft.Network/connections template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/connections", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "authorizationKey": "string", - "virtualNetworkGateway1": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "virtualNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "localNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "connectionType": "string", - "routingWeight": "integer", - "sharedKey": "string", - "peer": { - "id": "string" - }, - "enableBgp": "boolean", - "usePolicyBasedTrafficSelectors": "boolean", - "ipsecPolicies": [ - { - "saLifeTimeSeconds": "integer", - "saDataSizeKilobytes": "integer", - "ipsecEncryption": "string", - "ipsecIntegrity": "string", - "ikeEncryption": "string", - "ikeIntegrity": "string", - "dhGroup": "string", - "pfsGroup": "string" - } - ], - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/connections | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway connection. - [VirtualNetworkGatewayConnectionPropertiesFormat object](#VirtualNetworkGatewayConnectionPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayConnectionPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorizationKey. | -| virtualNetworkGateway1 | object | Yes | The reference to virtual network gateway resource. - [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| virtualNetworkGateway2 | object | No | The reference to virtual network gateway resource. - [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| localNetworkGateway2 | object | No | The reference to local network gateway resource. - [LocalNetworkGateway object](#LocalNetworkGateway) | -| connectionType | enum | Yes | Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. - IPsec, Vnet2Vnet, ExpressRoute, VPNClient | -| routingWeight | integer | No | The routing weight. | -| sharedKey | string | No | The IPSec shared key. | -| peer | object | No | The reference to peerings resource. - [SubResource object](#SubResource) | -| enableBgp | boolean | No | EnableBgp flag | -| usePolicyBasedTrafficSelectors | boolean | No | Enable policy-based traffic selectors. | -| ipsecPolicies | array | No | The IPSec Policies to be considered by this connection. - [IpsecPolicy object](#IpsecPolicy) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGatewayConnection resource. | - - - -### VirtualNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway. - [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the local network gateway. - [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### IpsecPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| saLifeTimeSeconds | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. | -| saDataSizeKilobytes | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. | -| ipsecEncryption | enum | Yes | The IPSec encryption algorithm (IKE phase 1). - None, DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256 | -| ipsecIntegrity | enum | Yes | The IPSec integrity algorithm (IKE phase 1). - MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256 | -| ikeEncryption | enum | Yes | The IKE encryption algorithm (IKE phase 2). - DES, DES3, AES128, AES192, AES256 | -| ikeIntegrity | enum | Yes | The IKE integrity algorithm (IKE phase 2). - MD5, SHA1, SHA256, SHA384 | -| dhGroup | enum | Yes | The DH Groups used in IKE Phase 1 for initial SA. - None, DHGroup1, DHGroup2, DHGroup14, DHGroup2048, ECP256, ECP384, DHGroup24 | -| pfsGroup | enum | Yes | The DH Groups used in IKE Phase 2 for new child SA. - None, PFS1, PFS2, PFS2048, ECP256, ECP384, PFS24 | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network gateway ip configuration. - [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | -| vpnClientProtocols | array | No | VpnClientProtocols for Virtual network gateway. - IkeV2 or SSTP | -| radiusServerAddress | string | No | The radius server address property of the VirtualNetworkGateway resource for vpn client connection. | -| radiusServerSecret | string | No | The radius secret property of the VirtualNetworkGateway resource for vpn client connection. | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the vpn client root certificate. - [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the vpn client revoked certificate. - [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-08-01/expressRouteCircuits.md b/test/Resource/Expected/Network/2017-08-01/expressRouteCircuits.md deleted file mode 100644 index 30f712d..0000000 --- a/test/Resource/Expected/Network/2017-08-01/expressRouteCircuits.md +++ /dev/null @@ -1,326 +0,0 @@ -# Microsoft.Network/expressRouteCircuits template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "family": "string" - }, - "properties": { - "allowClassicOperations": "boolean", - "circuitProvisioningState": "string", - "serviceProviderProvisioningState": "string", - "authorizations": [ - { - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "name": "string" - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - "ExpressRouteCircuitPeering" - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - "ExpressRouteCircuitPeering" - ] - } - }, - "state": "string" - } - }, - "name": "string" - } - ], - "serviceKey": "string", - "serviceProviderNotes": "string", - "serviceProviderProperties": { - "serviceProviderName": "string", - "peeringLocation": "string", - "bandwidthInMbps": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The SKU. - [ExpressRouteCircuitSku object](#ExpressRouteCircuitSku) | -| properties | object | Yes | [ExpressRouteCircuitPropertiesFormat object](#ExpressRouteCircuitPropertiesFormat) | -| resources | array | No | [peerings](./expressRouteCircuits/peerings.md) [authorizations](./expressRouteCircuits/authorizations.md) | - - - -### ExpressRouteCircuitSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the SKU. | -| tier | enum | No | The tier of the SKU. Possible values are 'Standard' and 'Premium'. - Standard or Premium | -| family | enum | No | The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. - UnlimitedData or MeteredData | - - - -### ExpressRouteCircuitPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowClassicOperations | boolean | No | Allow classic operations | -| circuitProvisioningState | string | No | The CircuitProvisioningState state of the resource. | -| serviceProviderProvisioningState | enum | No | The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - NotProvisioned, Provisioning, Provisioned, Deprovisioning | -| authorizations | array | No | The list of authorizations. - [ExpressRouteCircuitAuthorization object](#ExpressRouteCircuitAuthorization) | -| peerings | array | No | The list of peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | -| serviceKey | string | No | The ServiceKey. | -| serviceProviderNotes | string | No | The ServiceProviderNotes. | -| serviceProviderProperties | object | No | The ServiceProviderProperties. - [ExpressRouteCircuitServiceProviderProperties object](#ExpressRouteCircuitServiceProviderProperties) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | - - - -### ExpressRouteCircuitAuthorization object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitServiceProviderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceProviderName | string | No | The serviceProviderName. | -| peeringLocation | string | No | The peering location. | -| bandwidthInMbps | integer | No | The BandwidthInMbps. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-08-01/expressRouteCircuits/authorizations.md b/test/Resource/Expected/Network/2017-08-01/expressRouteCircuits/authorizations.md deleted file mode 100644 index 3d18684..0000000 --- a/test/Resource/Expected/Network/2017-08-01/expressRouteCircuits/authorizations.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/authorizations template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/authorizations", - "apiVersion": "2017-08-01", - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/authorizations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/authorizations | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/expressRouteCircuits/peerings.md b/test/Resource/Expected/Network/2017-08-01/expressRouteCircuits/peerings.md deleted file mode 100644 index cd95ef9..0000000 --- a/test/Resource/Expected/Network/2017-08-01/expressRouteCircuits/peerings.md +++ /dev/null @@ -1,239 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/peerings template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/peerings", - "apiVersion": "2017-08-01", - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": "ExpressRouteCircuitPeeringPropertiesFormat", - "name": "string" - } - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": "ExpressRouteCircuitPeeringPropertiesFormat", - "name": "string" - } - ] - } - }, - "state": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/peerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/peerings | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-08-01/loadBalancers.md b/test/Resource/Expected/Network/2017-08-01/loadBalancers.md deleted file mode 100644 index c211d42..0000000 --- a/test/Resource/Expected/Network/2017-08-01/loadBalancers.md +++ /dev/null @@ -1,673 +0,0 @@ -# Microsoft.Network/loadBalancers template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/loadBalancers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "zones": [ - "string" - ] - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendAddressPool": { - "id": "string" - }, - "probe": { - "id": "string" - }, - "protocol": "string", - "loadDistribution": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "disableOutboundSnat": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "port": "integer", - "intervalInSeconds": "integer", - "numberOfProbes": "integer", - "requestPath": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatPools": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "backendPort": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "outboundNatRules": [ - { - "id": "string", - "properties": { - "allocatedOutboundPorts": "integer", - "frontendIPConfigurations": [ - { - "id": "string" - } - ], - "backendAddressPool": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The load balancer SKU. - [LoadBalancerSku object](#LoadBalancerSku) | -| properties | object | Yes | Properties of load balancer. - [LoadBalancerPropertiesFormat object](#LoadBalancerPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [inboundNatRules](./loadBalancers/inboundNatRules.md) | - - - -### LoadBalancerSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a load balancer SKU. - Basic or Standard | - - - -### LoadBalancerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfigurations | array | No | Object representing the frontend IPs to be used for the load balancer - [FrontendIPConfiguration object](#FrontendIPConfiguration) | -| backendAddressPools | array | No | Collection of backend address pools used by a load balancer - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancingRules | array | No | Object collection representing the load balancing rules Gets the provisioning - [LoadBalancingRule object](#LoadBalancingRule) | -| probes | array | No | Collection of probe objects used in the load balancer - [Probe object](#Probe) | -| inboundNatRules | array | No | 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. - [InboundNatRule object](#InboundNatRule) | -| inboundNatPools | array | No | 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. - [InboundNatPool object](#InboundNatPool) | -| outboundNatRules | array | No | The outbound NAT rules. - [OutboundNatRule object](#OutboundNatRule) | -| resourceGuid | string | No | The resource GUID property of the load balancer resource. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### FrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the load balancer probe. - [FrontendIPConfigurationPropertiesFormat object](#FrontendIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer load balancing rule. - [LoadBalancingRulePropertiesFormat object](#LoadBalancingRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Probe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer probe. - [ProbePropertiesFormat object](#ProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat pool. - [InboundNatPoolPropertiesFormat object](#InboundNatPoolPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### OutboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer outbound nat rule. - [OutboundNatRulePropertiesFormat object](#OutboundNatRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### FrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | The private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [Subnet object](#Subnet) | -| publicIPAddress | object | No | The reference of the Public IP resource. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### LoadBalancingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| backendAddressPool | object | No | A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| probe | object | No | The reference of the load balancer probe used by the load balancing rule. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'. - Udp or Tcp | -| loadDistribution | enum | No | The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. - Default, SourceIP, SourceIPProtocol | -| frontendPort | integer | Yes | 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. | -| backendPort | integer | No | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| disableOutboundSnat | boolean | No | Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | Yes | 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. - Http or Tcp | -| port | integer | Yes | The port for communicating the probe. Possible values range from 1 to 65535, inclusive. | -| intervalInSeconds | integer | No | 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. | -| numberOfProbes | integer | No | 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. | -| requestPath | string | No | 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. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | Yes | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPortRangeStart | integer | Yes | 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. | -| frontendPortRangeEnd | integer | Yes | 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. | -| backendPort | integer | Yes | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### OutboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allocatedOutboundPorts | integer | No | The number of outbound ports to be used for NAT. | -| frontendIPConfigurations | array | No | The Frontend IP addresses of the load balancer. - [SubResource object](#SubResource) | -| backendAddressPool | object | Yes | A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/loadBalancers/inboundNatRules.md b/test/Resource/Expected/Network/2017-08-01/loadBalancers/inboundNatRules.md deleted file mode 100644 index f656808..0000000 --- a/test/Resource/Expected/Network/2017-08-01/loadBalancers/inboundNatRules.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/loadBalancers/inboundNatRules template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/loadBalancers/inboundNatRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers/inboundNatRules", - "apiVersion": "2017-08-01", - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers/inboundNatRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers/inboundNatRules | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - diff --git a/test/Resource/Expected/Network/2017-08-01/localNetworkGateways.md b/test/Resource/Expected/Network/2017-08-01/localNetworkGateways.md deleted file mode 100644 index 2b232cd..0000000 --- a/test/Resource/Expected/Network/2017-08-01/localNetworkGateways.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/localNetworkGateways template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/localNetworkGateways", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/localNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/localNetworkGateways | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the local network gateway. - [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - diff --git a/test/Resource/Expected/Network/2017-08-01/networkInterfaces.md b/test/Resource/Expected/Network/2017-08-01/networkInterfaces.md deleted file mode 100644 index 76a10a8..0000000 --- a/test/Resource/Expected/Network/2017-08-01/networkInterfaces.md +++ /dev/null @@ -1,645 +0,0 @@ -# Microsoft.Network/networkInterfaces template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/networkInterfaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkInterfaces", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableAcceleratedNetworking": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkInterfaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkInterfaces | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the network interface. - [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | The reference of a virtual machine. - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | A list of IPConfigurations of the network interface. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | The DNS settings in network interface. - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | The MAC address of the network interface. | -| primary | boolean | No | Gets whether this is a primary network interface on a virtual machine. | -| enableAcceleratedNetworking | boolean | No | If the network interface is accelerated networking enabled. | -| enableIPForwarding | boolean | No | Indicates whether IP forwarding is enabled on this network interface. | -| resourceGuid | string | No | The resource GUID property of the network interface resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Network interface IP configuration properties. - [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | 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. - string | -| appliedDnsServers | array | No | 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. - string | -| internalDnsNameLabel | string | No | Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. | -| internalFqdn | string | No | Fully qualified DNS name supporting internal communications between VMs in the same virtual network. | -| internalDomainNameSuffix | string | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | Private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | Subnet bound to the IP configuration. - [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | Public IP address bound to the IP configuration. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'. - Udp or Tcp | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/networkSecurityGroups.md b/test/Resource/Expected/Network/2017-08-01/networkSecurityGroups.md deleted file mode 100644 index e25b599..0000000 --- a/test/Resource/Expected/Network/2017-08-01/networkSecurityGroups.md +++ /dev/null @@ -1,142 +0,0 @@ -# Microsoft.Network/networkSecurityGroups template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [securityRules](./networkSecurityGroups/securityRules.md) | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/networkSecurityGroups/securityRules.md b/test/Resource/Expected/Network/2017-08-01/networkSecurityGroups/securityRules.md deleted file mode 100644 index f0e7906..0000000 --- a/test/Resource/Expected/Network/2017-08-01/networkSecurityGroups/securityRules.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/networkSecurityGroups/securityRules template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups/securityRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups/securityRules", - "apiVersion": "2017-08-01", - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups/securityRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups/securityRules | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/networkWatchers.md b/test/Resource/Expected/Network/2017-08-01/networkWatchers.md deleted file mode 100644 index a6201a1..0000000 --- a/test/Resource/Expected/Network/2017-08-01/networkWatchers.md +++ /dev/null @@ -1,37 +0,0 @@ -# Microsoft.Network/networkWatchers template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/networkWatchers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "etag": "string", - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| properties | object | Yes | [NetworkWatcherPropertiesFormat object](#NetworkWatcherPropertiesFormat) | -| resources | array | No | [packetCaptures](./networkWatchers/packetCaptures.md) | - diff --git a/test/Resource/Expected/Network/2017-08-01/networkWatchers/packetCaptures.md b/test/Resource/Expected/Network/2017-08-01/networkWatchers/packetCaptures.md deleted file mode 100644 index ee4f9d0..0000000 --- a/test/Resource/Expected/Network/2017-08-01/networkWatchers/packetCaptures.md +++ /dev/null @@ -1,78 +0,0 @@ -# Microsoft.Network/networkWatchers/packetCaptures template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers/packetCaptures", - "apiVersion": "2017-08-01", - "properties": { - "target": "string", - "bytesToCapturePerPacket": "integer", - "totalBytesPerSession": "integer", - "timeLimitInSeconds": "integer", - "storageLocation": { - "storageId": "string", - "storagePath": "string", - "filePath": "string" - }, - "filters": [ - { - "protocol": "string", - "localIPAddress": "string", - "remoteIPAddress": "string", - "localPort": "string", - "remotePort": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers/packetCaptures object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers/packetCaptures | -| apiVersion | enum | Yes | 2017-08-01 | -| properties | object | Yes | [PacketCaptureParameters object](#PacketCaptureParameters) | - - - -### PacketCaptureParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| target | string | Yes | The ID of the targeted resource, only VM is currently supported. | -| bytesToCapturePerPacket | integer | No | Number of bytes captured per packet, the remaining bytes are truncated. | -| totalBytesPerSession | integer | No | Maximum size of the capture output. | -| timeLimitInSeconds | integer | No | Maximum duration of the capture session in seconds. | -| storageLocation | object | Yes | [PacketCaptureStorageLocation object](#PacketCaptureStorageLocation) | -| filters | array | No | [PacketCaptureFilter object](#PacketCaptureFilter) | - - - -### PacketCaptureStorageLocation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageId | string | No | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | -| storagePath | string | No | 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. | -| filePath | string | No | 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. | - - - -### PacketCaptureFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol to be filtered on. - TCP, UDP, Any | -| localIPAddress | string | No | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | -| remoteIPAddress | string | No | 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 | No | 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. | -| remotePort | string | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-08-01/publicIPAddresses.md b/test/Resource/Expected/Network/2017-08-01/publicIPAddresses.md deleted file mode 100644 index e0d8359..0000000 --- a/test/Resource/Expected/Network/2017-08-01/publicIPAddresses.md +++ /dev/null @@ -1,84 +0,0 @@ -# Microsoft.Network/publicIPAddresses template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/publicIPAddresses", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/publicIPAddresses object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/publicIPAddresses | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | Yes | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-08-01/routeFilters.md b/test/Resource/Expected/Network/2017-08-01/routeFilters.md deleted file mode 100644 index a300b33..0000000 --- a/test/Resource/Expected/Network/2017-08-01/routeFilters.md +++ /dev/null @@ -1,222 +0,0 @@ -# Microsoft.Network/routeFilters template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/routeFilters resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "RouteFilterPropertiesFormat" - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "RouteFilterPropertiesFormat" - }, - "state": "string" - } - }, - "name": "string" - } - ] - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | -| resources | array | No | [routeFilterRules](./routeFilters/routeFilterRules.md) | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - diff --git a/test/Resource/Expected/Network/2017-08-01/routeFilters/routeFilterRules.md b/test/Resource/Expected/Network/2017-08-01/routeFilters/routeFilterRules.md deleted file mode 100644 index f2175f9..0000000 --- a/test/Resource/Expected/Network/2017-08-01/routeFilters/routeFilterRules.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.Network/routeFilters/routeFilterRules template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/routeFilters/routeFilterRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters/routeFilterRules", - "apiVersion": "2017-08-01", - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters/routeFilterRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters/routeFilterRules | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-08-01/routeTables.md b/test/Resource/Expected/Network/2017-08-01/routeTables.md deleted file mode 100644 index e1c8249..0000000 --- a/test/Resource/Expected/Network/2017-08-01/routeTables.md +++ /dev/null @@ -1,80 +0,0 @@ -# Microsoft.Network/routeTables template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/routeTables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [routes](./routeTables/routes.md) | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/routeTables/routes.md b/test/Resource/Expected/Network/2017-08-01/routeTables/routes.md deleted file mode 100644 index 716a83a..0000000 --- a/test/Resource/Expected/Network/2017-08-01/routeTables/routes.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Network/routeTables/routes template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/routeTables/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables/routes", - "apiVersion": "2017-08-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables/routes | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/virtualNetworkGateways.md b/test/Resource/Expected/Network/2017-08-01/virtualNetworkGateways.md deleted file mode 100644 index d3811d2..0000000 --- a/test/Resource/Expected/Network/2017-08-01/virtualNetworkGateways.md +++ /dev/null @@ -1,215 +0,0 @@ -# Microsoft.Network/virtualNetworkGateways template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/virtualNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworkGateways", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworkGateways | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway. - [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network gateway ip configuration. - [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | -| vpnClientProtocols | array | No | VpnClientProtocols for Virtual network gateway. - IkeV2 or SSTP | -| radiusServerAddress | string | No | The radius server address property of the VirtualNetworkGateway resource for vpn client connection. | -| radiusServerSecret | string | No | The radius secret property of the VirtualNetworkGateway resource for vpn client connection. | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the vpn client root certificate. - [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the vpn client revoked certificate. - [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-08-01/virtualNetworks.md b/test/Resource/Expected/Network/2017-08-01/virtualNetworks.md deleted file mode 100644 index 1404c95..0000000 --- a/test/Resource/Expected/Network/2017-08-01/virtualNetworks.md +++ /dev/null @@ -1,386 +0,0 @@ -# Microsoft.Network/virtualNetworks template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/virtualNetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks", - "apiVersion": "2017-08-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "addressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "string" - ] - }, - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "virtualNetworkPeerings": [ - { - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network. - [VirtualNetworkPropertiesFormat object](#VirtualNetworkPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [virtualNetworkPeerings](./virtualNetworks/virtualNetworkPeerings.md) [subnets](./virtualNetworks/subnets.md) | - - - -### VirtualNetworkPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressSpace | object | No | The AddressSpace that contains an array of IP address ranges that can be used by subnets. - [AddressSpace object](#AddressSpace) | -| dhcpOptions | object | No | The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. - [DhcpOptions object](#DhcpOptions) | -| subnets | array | No | A list of subnets in a Virtual Network. - [Subnet object](#Subnet) | -| virtualNetworkPeerings | array | No | A list of peerings in a Virtual Network. - [VirtualNetworkPeering object](#VirtualNetworkPeering) | -| resourceGuid | string | No | The resourceGuid property of the Virtual Network resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### DhcpOptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | The list of DNS servers IP addresses. - string | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network peering. - [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/virtualNetworks/subnets.md b/test/Resource/Expected/Network/2017-08-01/virtualNetworks/subnets.md deleted file mode 100644 index 88136db..0000000 --- a/test/Resource/Expected/Network/2017-08-01/virtualNetworks/subnets.md +++ /dev/null @@ -1,275 +0,0 @@ -# Microsoft.Network/virtualNetworks/subnets template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/subnets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/subnets", - "apiVersion": "2017-08-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/subnets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/subnets | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-08-01/virtualNetworks/virtualNetworkPeerings.md b/test/Resource/Expected/Network/2017-08-01/virtualNetworks/virtualNetworkPeerings.md deleted file mode 100644 index 78d2709..0000000 --- a/test/Resource/Expected/Network/2017-08-01/virtualNetworks/virtualNetworkPeerings.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/virtualNetworks/virtualNetworkPeerings template reference -API Version: 2017-08-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/virtualNetworkPeerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings", - "apiVersion": "2017-08-01", - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "peeringState": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/virtualNetworkPeerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/virtualNetworkPeerings | -| apiVersion | enum | Yes | 2017-08-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the virtual network peering. - [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. - [SubResource object](#SubResource) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - diff --git a/test/Resource/Expected/Network/2017-09-01/Microsoft.Network.json b/test/Resource/Expected/Network/2017-09-01/Microsoft.Network.json deleted file mode 100644 index 7ec6d55..0000000 --- a/test/Resource/Expected/Network/2017-09-01/Microsoft.Network.json +++ /dev/null @@ -1,7464 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-09-01/Microsoft.Network.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Network", - "description": "Microsoft Network Resource Types", - "resourceDefinitions": { - "applicationGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationGateways" - }, - "applicationSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the application security group." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationSecurityGroups" - }, - "connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway connection." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/connections" - }, - "expressRouteCircuits": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/expressRouteCircuits_authorizations_childResource" - }, - { - "$ref": "#/definitions/expressRouteCircuits_peerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits" - }, - "expressRouteCircuits_authorizations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "loadBalancers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load balancer SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/loadBalancers_inboundNatRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers" - }, - "loadBalancers_inboundNatRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers/inboundNatRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers/inboundNatRules" - }, - "localNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/localNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the local network gateway." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/localNetworkGateways" - }, - "networkInterfaces": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkInterfaces" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network interface." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkInterfaces" - }, - "networkSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network security group" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkSecurityGroups_securityRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups" - }, - "networkSecurityGroups_securityRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups/securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "networkWatchers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkWatcherPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkWatchers_packetCaptures_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers" - }, - "networkWatchers_packetCaptures": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers/packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "publicIPAddresses": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/publicIPAddresses" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address properties." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/publicIPAddresses" - }, - "routeFilters": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeFilters_routeFilterRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters" - }, - "routeFilters_routeFilterRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters/routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "routeTables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route table." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeTables_routes_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables" - }, - "routeTables_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "virtualNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworkGateways" - }, - "virtualNetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualNetworks_subnets_childResource" - }, - { - "$ref": "#/definitions/virtualNetworks_virtualNetworkPeerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks" - }, - "virtualNetworks_subnets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - } - }, - "definitions": { - "AddressSpace": { - "type": "object", - "properties": { - "addressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of address blocks reserved for this virtual network in CIDR notation." - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." - }, - "ApplicationGatewayAuthenticationCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Authentication certificates of an application gateway." - }, - "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Certificate public data." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Authentication certificates properties of an application gateway." - }, - "ApplicationGatewayBackendAddress": { - "type": "object", - "properties": { - "fqdn": { - "type": "string", - "description": "Fully qualified domain name (FQDN)." - }, - "ipAddress": { - "type": "string", - "description": "IP address" - } - }, - "description": "Backend address of an application gateway." - }, - "ApplicationGatewayBackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of references to IPs defined in network interfaces." - }, - "backendAddresses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddress" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend addresses" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendHttpSettings": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Backend address pool settings of an application gateway." - }, - "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Port" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "cookieBasedAffinity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cookie based affinity." - }, - "requestTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probe resource of an application gateway." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of references to application gateway authentication certificates." - }, - "connectionDraining": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayConnectionDraining" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connection draining of the backend http settings resource." - }, - "hostName": { - "type": "string", - "description": "Host header to be sent to the backend servers." - }, - "pickHostNameFromBackendAddress": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." - }, - "affinityCookieName": { - "type": "string", - "description": "Cookie name to use for the affinity cookie." - }, - "probeEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the probe is enabled. Default value is false." - }, - "path": { - "type": "string", - "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend address pool settings of an application gateway." - }, - "ApplicationGatewayConnectionDraining": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether connection draining is enabled or not." - }, - "drainTimeoutInSec": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 3600 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." - } - }, - "required": [ - "enabled", - "drainTimeoutInSec" - ], - "description": "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." - }, - "ApplicationGatewayFirewallDisabledRuleGroup": { - "type": "object", - "properties": { - "ruleGroupName": { - "type": "string", - "description": "The name of the rule group that will be disabled." - }, - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." - } - }, - "required": [ - "ruleGroupName" - ], - "description": "Allows to disable rules within a rule group or an entire rule group." - }, - "ApplicationGatewayFrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "PrivateIPAddress of the network interface IP Configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PrivateIP allocation method." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the PublicIP resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendPort": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Frontend port of an application gateway." - }, - "ApplicationGatewayFrontendPortPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend port of an application gateway." - }, - "ApplicationGatewayHttpListener": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Http listener of an application gateway." - }, - "ApplicationGatewayHttpListenerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP configuration resource of an application gateway." - }, - "frontendPort": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of an application gateway." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "hostName": { - "type": "string", - "description": "Host name of HTTP listener." - }, - "sslCertificate": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificate resource of an application gateway." - }, - "requireServerNameIndication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of HTTP listener of an application gateway." - }, - "ApplicationGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." - }, - "ApplicationGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration of an application gateway." - }, - "ApplicationGatewayPathRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Path rule of URL path map of an application gateway." - }, - "ApplicationGatewayPathRulePropertiesFormat": { - "type": "object", - "properties": { - "paths": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules of URL path map." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of URL path map path rule." - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings resource of URL path map path rule." - }, - "redirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configuration resource of URL path map path rule." - }, - "provisioningState": { - "type": "string", - "description": "Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of path rule of an application gateway." - }, - "ApplicationGatewayProbe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Probe of the application gateway." - }, - "ApplicationGatewayProbeHealthResponseMatch": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "Body that must be contained in the health response. Default value is empty." - }, - "statusCodes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." - } - }, - "description": "Application gateway probe health response match" - }, - "ApplicationGatewayProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "host": { - "type": "string", - "description": "Host name to send the probe to." - }, - "path": { - "type": "string", - "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:" - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." - }, - "timeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." - }, - "pickHostNameFromBackendHttpSettings": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the host header should be picked from the backend http settings. Default value is false." - }, - "minServers": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum number of servers that are always marked healthy. Default value is 0." - }, - "match": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Criterion for classifying a healthy probe response." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayPropertiesFormat": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU of the application gateway resource." - }, - "sslPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL policy of the application gateway resource." - }, - "gatewayIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnets of application the gateway resource." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Authentication certificates of the application gateway resource." - }, - "sslCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewaySslCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificates of the application gateway resource." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP addresses of the application gateway resource." - }, - "frontendPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendPort" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend ports of the application gateway resource." - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayProbe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probes of the application gateway resource." - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool of the application gateway resource." - }, - "backendHttpSettingsCollection": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings of the application gateway resource." - }, - "httpListeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayHttpListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listeners of the application gateway resource." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayUrlPathMap" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map of the application gateway resource." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing rules of the application gateway resource." - }, - "redirectConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configurations of the application gateway resource." - }, - "webApplicationFirewallConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall configuration." - }, - "resourceGuid": { - "type": "string", - "description": "Resource GUID property of the application gateway resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the application gateway." - }, - "ApplicationGatewayRedirectConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Redirect configuration of an application gateway." - }, - "ApplicationGatewayRedirectConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "redirectType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Permanent", - "Found", - "SeeOther", - "Temporary" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Supported http redirection types - Permanent, Temporary, Found, SeeOther." - }, - "targetListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference to a listener to redirect the request to." - }, - "targetUrl": { - "type": "string", - "description": "Url to redirect the request to." - }, - "includePath": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Include path in the redirected url." - }, - "includeQueryString": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Include query string in the redirected url." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing specifying redirect configuration." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Url path maps specifying default redirect configuration." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules specifying redirect configuration." - } - }, - "description": "Properties of redirect configuration of the application gateway." - }, - "ApplicationGatewayRequestRoutingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Request routing rule of an application gateway." - }, - "ApplicationGatewayRequestRoutingRulePropertiesFormat": { - "type": "object", - "properties": { - "ruleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "PathBasedRouting" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Rule type." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of the application gateway. " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of the application gateway." - }, - "httpListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listener resource of the application gateway. " - }, - "urlPathMap": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map resource of the application gateway." - }, - "redirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configuration resource of the application gateway." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of request routing rule of the application gateway." - }, - "ApplicationGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_Small", - "Standard_Medium", - "Standard_Large", - "WAF_Medium", - "WAF_Large" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of an application gateway SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "WAF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tier of an application gateway." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity (instance count) of an application gateway." - } - }, - "description": "SKU of an application gateway" - }, - "ApplicationGatewaySslCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "SSL certificates of an application gateway." - }, - "ApplicationGatewaySslCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." - }, - "password": { - "type": "string", - "description": "Password for the pfx file specified in data. Only applicable in PUT request." - }, - "publicCertData": { - "type": "string", - "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of SSL certificates of an application gateway." - }, - "ApplicationGatewaySslPolicy": { - "type": "object", - "properties": { - "disabledSslProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ssl protocols to be disabled on application gateway." - }, - "policyType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Predefined", - "Custom" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of Ssl Policy." - }, - "policyName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AppGwSslPolicy20150501", - "AppGwSslPolicy20170401", - "AppGwSslPolicy20170401S" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of Ssl predefined policy." - }, - "cipherSuites": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", - "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", - "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", - "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", - "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", - "TLS_RSA_WITH_AES_256_GCM_SHA384", - "TLS_RSA_WITH_AES_128_GCM_SHA256", - "TLS_RSA_WITH_AES_256_CBC_SHA256", - "TLS_RSA_WITH_AES_128_CBC_SHA256", - "TLS_RSA_WITH_AES_256_CBC_SHA", - "TLS_RSA_WITH_AES_128_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", - "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", - "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", - "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", - "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", - "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", - "TLS_RSA_WITH_3DES_EDE_CBC_SHA" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ssl cipher suites to be enabled in the specified order to application gateway." - }, - "minProtocolVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum version of Ssl protocol to be supported on application gateway." - } - }, - "description": "Application Gateway Ssl policy." - }, - "ApplicationGatewayUrlPathMap": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." - }, - "ApplicationGatewayUrlPathMapPropertiesFormat": { - "type": "object", - "properties": { - "defaultBackendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend address pool resource of URL path map." - }, - "defaultBackendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend http settings resource of URL path map." - }, - "defaultRedirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default redirect configuration resource of URL path map." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayPathRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rule of URL path map resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of UrlPathMap of the application gateway." - }, - "ApplicationGatewayWebApplicationFirewallConfiguration": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the web application firewall is enabled or not." - }, - "firewallMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Detection", - "Prevention" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall mode." - }, - "ruleSetType": { - "type": "string", - "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." - }, - "ruleSetVersion": { - "type": "string", - "description": "The version of the rule set type." - }, - "disabledRuleGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The disabled rule groups." - } - }, - "required": [ - "enabled", - "firewallMode", - "ruleSetType", - "ruleSetVersion" - ], - "description": "Application gateway web application firewall configuration." - }, - "ApplicationSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the application security group." - } - }, - "description": "An application security group in a resource group." - }, - "ApplicationSecurityGroupPropertiesFormat": { - "type": "object", - "properties": {}, - "description": "Application security group properties." - }, - "AuthorizationPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorization key." - }, - "authorizationUseStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Available", - "InUse" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "BackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer backend address pool." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Pool of backend IP addresses." - }, - "BackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "description": "Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the backend address pool." - }, - "BgpSettings": { - "type": "object", - "properties": { - "asn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BGP speaker's ASN." - }, - "bgpPeeringAddress": { - "type": "string", - "description": "The BGP peering address and BGP identifier of this BGP speaker." - }, - "peerWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The weight added to routes learned from this BGP speaker." - } - }, - "description": "BGP settings details" - }, - "DhcpOptions": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of DNS servers IP addresses." - } - }, - "description": "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." - }, - "ExpressRouteCircuitAuthorization": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Authorization in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Peering in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "advertisedPublicPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of AdvertisedPublicPrefixes." - }, - "advertisedCommunities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The communities of bgp peering. Spepcified for microsoft peering" - }, - "advertisedPublicPrefixesState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotConfigured", - "Configuring", - "Configured", - "ValidationNeeded" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'." - }, - "legacyMode": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The legacy mode of the peering." - }, - "customerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CustomerASN of the peering." - }, - "routingRegistryName": { - "type": "string", - "description": "The RoutingRegistryName of the configuration." - } - }, - "description": "Specifies the peering configuration." - }, - "ExpressRouteCircuitPeeringPropertiesFormat": { - "type": "object", - "properties": { - "peeringType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzurePublicPeering", - "AzurePrivatePeering", - "MicrosoftPeering" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - }, - "azureASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Azure ASN." - }, - "peerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The peer ASN." - }, - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "primaryAzurePort": { - "type": "string", - "description": "The primary port." - }, - "secondaryAzurePort": { - "type": "string", - "description": "The secondary port." - }, - "sharedKey": { - "type": "string", - "description": "The shared key." - }, - "vlanId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The VLAN ID." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "stats": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitStats" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets peering stats." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets whether the provider or the customer last modified the peering." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "ipv6PeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPv6 peering configuration." - } - } - }, - "ExpressRouteCircuitPropertiesFormat": { - "type": "object", - "properties": { - "allowClassicOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allow classic operations" - }, - "circuitProvisioningState": { - "type": "string", - "description": "The CircuitProvisioningState state of the resource." - }, - "serviceProviderProvisioningState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotProvisioned", - "Provisioning", - "Provisioned", - "Deprovisioning" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'." - }, - "authorizations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitAuthorization" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of authorizations." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of peerings." - }, - "serviceKey": { - "type": "string", - "description": "The ServiceKey." - }, - "serviceProviderNotes": { - "type": "string", - "description": "The ServiceProviderNotes." - }, - "serviceProviderProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProperties." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - } - }, - "description": "Properties of ExpressRouteCircuit." - }, - "ExpressRouteCircuitServiceProviderProperties": { - "type": "object", - "properties": { - "serviceProviderName": { - "type": "string", - "description": "The serviceProviderName." - }, - "peeringLocation": { - "type": "string", - "description": "The peering location." - }, - "bandwidthInMbps": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BandwidthInMbps." - } - }, - "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tier of the SKU. Possible values are 'Standard' and 'Premium'." - }, - "family": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UnlimitedData", - "MeteredData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'." - } - }, - "description": "Contains SKU in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitStats": { - "type": "object", - "properties": { - "primarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "primarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - }, - "secondarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "secondarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - } - }, - "description": "Contains stats associated with the peering." - }, - "expressRouteCircuits_authorizations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "FrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the load balancer probe." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "description": "Frontend IP address of the load balancer." - }, - "FrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "The private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the Public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP Configuration of the load balancer." - }, - "InboundNatPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat pool." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT pool of the load balancer." - }, - "InboundNatPoolPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp", - "All" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPortRangeStart", - "frontendPortRangeEnd", - "backendPort" - ], - "description": "Properties of Inbound NAT pool." - }, - "InboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT rule of the load balancer." - }, - "InboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp", - "All" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the inbound NAT rule." - }, - "IpsecPolicy": { - "type": "object", - "properties": { - "saLifeTimeSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." - }, - "saDataSizeKilobytes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." - }, - "ipsecEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DES", - "DES3", - "AES128", - "AES192", - "AES256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec encryption algorithm (IKE phase 1)." - }, - "ipsecIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec integrity algorithm (IKE phase 1)." - }, - "ikeEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "DES", - "DES3", - "AES128", - "AES192", - "AES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE encryption algorithm (IKE phase 2)." - }, - "ikeIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "SHA384" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE integrity algorithm (IKE phase 2)." - }, - "dhGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DHGroup1", - "DHGroup2", - "DHGroup14", - "DHGroup2048", - "ECP256", - "ECP384", - "DHGroup24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 1 for initial SA." - }, - "pfsGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "PFS1", - "PFS2", - "PFS2048", - "ECP256", - "ECP384", - "PFS24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 2 for new child SA." - } - }, - "required": [ - "saLifeTimeSeconds", - "saDataSizeKilobytes", - "ipsecEncryption", - "ipsecIntegrity", - "ikeEncryption", - "ikeIntegrity", - "dhGroup", - "pfsGroup" - ], - "description": "An IPSec Policy configuration for a virtual network gateway connection" - }, - "Ipv6ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - } - }, - "description": "Contains IPv6 peering config." - }, - "LoadBalancerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/FrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object representing the frontend IPs to be used for the load balancer" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of backend address pools used by a load balancer" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object collection representing the load balancing rules Gets the provisioning " - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Probe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of probe objects used in the load balancer" - }, - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/OutboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The outbound NAT rules." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the load balancer resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the load balancer." - }, - "LoadBalancerSku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of a load balancer SKU." - } - }, - "description": "SKU of a load balancer" - }, - "loadBalancers_inboundNatRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "inboundNatRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers/inboundNatRules" - }, - "LoadBalancingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer load balancing rule." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancing rule for a load balancer." - }, - "LoadBalancingRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the load balancer probe used by the load balancing rule." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp", - "All" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "loadDistribution": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "SourceIP", - "SourceIPProtocol" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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\"" - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables \"Any Port\"" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "disableOutboundSnat": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPort" - ], - "description": "Properties of the load balancer." - }, - "LocalNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the local network gateway." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "LocalNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "localNetworkAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network site address space." - }, - "gatewayIpAddress": { - "type": "string", - "description": "IP address of local network gateway." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the LocalNetworkGateway resource." - } - }, - "description": "LocalNetworkGateway properties" - }, - "NetworkInterfaceDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "appliedDnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "internalDnsNameLabel": { - "type": "string", - "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." - }, - "internalFqdn": { - "type": "string", - "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." - }, - "internalDomainNameSuffix": { - "type": "string", - "description": "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." - } - }, - "description": "DNS settings of a network interface." - }, - "NetworkInterfaceIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network interface IP configuration properties." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IPConfiguration in a network interface." - }, - "NetworkInterfaceIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of ApplicationGatewayBackendAddressPool resource." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of LoadBalancerBackendAddressPool resource." - }, - "loadBalancerInboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references of LoadBalancerInboundNatRules." - }, - "privateIPAddress": { - "type": "string", - "description": "Private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnet bound to the IP configuration." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary customer address on the network interface." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address bound to the IP configuration." - }, - "applicationSecurityGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationSecurityGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Application security groups in which the IP configuration is included." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration." - }, - "NetworkInterfacePropertiesFormat": { - "type": "object", - "properties": { - "virtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of a virtual machine." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of IPConfigurations of the network interface." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DNS settings in network interface." - }, - "macAddress": { - "type": "string", - "description": "The MAC address of the network interface." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary network interface on a virtual machine." - }, - "enableAcceleratedNetworking": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the network interface is accelerated networking enabled." - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether IP forwarding is enabled on this network interface." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network interface resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "NetworkInterface properties. " - }, - "NetworkSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network security group" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "NetworkSecurityGroup resource." - }, - "NetworkSecurityGroupPropertiesFormat": { - "type": "object", - "properties": { - "securityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of security rules of the network security group." - }, - "defaultSecurityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The default security rules of network security group." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network security group resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Network Security Group resource." - }, - "networkSecurityGroups_securityRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "NetworkWatcherPropertiesFormat": { - "type": "object", - "properties": {}, - "description": "The network watcher properties." - }, - "networkWatchers_packetCaptures_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "OutboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OutboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer outbound nat rule." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Outbound NAT pool of the load balancer." - }, - "OutboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "allocatedOutboundPorts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of outbound ports to be used for NAT." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Frontend IP addresses of the load balancer." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "backendAddressPool" - ], - "description": "Outbound NAT pool of the load balancer." - }, - "PacketCaptureFilter": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TCP", - "UDP", - "Any" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol to be filtered on." - }, - "localIPAddress": { - "type": "string", - "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." - }, - "remoteIPAddress": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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." - }, - "remotePort": { - "type": "string", - "description": "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." - } - }, - "description": "Filter that is applied to packet capture request. Multiple filters can be applied." - }, - "PacketCaptureParameters": { - "type": "object", - "properties": { - "target": { - "type": "string", - "description": "The ID of the targeted resource, only VM is currently supported." - }, - "bytesToCapturePerPacket": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of bytes captured per packet, the remaining bytes are truncated." - }, - "totalBytesPerSession": { - "oneOf": [ - { - "type": "integer", - "default": "1073741824" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum size of the capture output." - }, - "timeLimitInSeconds": { - "oneOf": [ - { - "type": "integer", - "default": "18000" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum duration of the capture session in seconds." - }, - "storageLocation": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureStorageLocation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "filters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PacketCaptureFilter" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "target", - "storageLocation" - ], - "description": "Parameters that define the create packet capture operation." - }, - "PacketCaptureStorageLocation": { - "type": "object", - "properties": { - "storageId": { - "type": "string", - "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." - }, - "storagePath": { - "type": "string", - "description": "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." - }, - "filePath": { - "type": "string", - "description": "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." - } - }, - "description": "Describes the storage location for a packet capture session." - }, - "Probe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer probe." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancer probe." - }, - "ProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." - }, - "intervalInSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "numberOfProbes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "requestPath": { - "type": "string", - "description": "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." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "port" - ], - "description": "Load balancer probe resource." - }, - "PublicIPAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address properties." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "description": "Public IP address resource." - }, - "PublicIPAddressDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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. " - } - }, - "description": "Contains FQDN of the DNS record associated with the public IP address" - }, - "PublicIPAddressPropertiesFormat": { - "type": "object", - "properties": { - "publicIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "publicIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The FQDN of the DNS record associated with the public IP address." - }, - "ipAddress": { - "type": "string", - "description": "The IP address associated with the public IP address resource." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The idle timeout of the public IP address." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Public IP address properties." - }, - "PublicIPAddressSku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of a public IP address SKU." - } - }, - "description": "SKU of a public IP address" - }, - "ResourceNavigationLink": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceNavigationLinkFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource navigation link properties format." - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "ResourceNavigationLink resource." - }, - "ResourceNavigationLinkFormat": { - "type": "object", - "properties": { - "linkedResourceType": { - "type": "string", - "description": "Resource type of the linked resource." - }, - "link": { - "type": "string", - "description": "Link to the external resource" - } - }, - "description": "Properties of ResourceNavigationLink." - }, - "Route": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route resource" - }, - "RouteFilter": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Route Filter Resource." - }, - "RouteFilterPropertiesFormat": { - "type": "object", - "properties": { - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RouteFilterRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of RouteFilterRules contained within a route filter." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of references to express route circuit peerings." - } - }, - "description": "Route Filter Resource" - }, - "RouteFilterRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "description": "Route Filter Rule Resource" - }, - "RouteFilterRulePropertiesFormat": { - "type": "object", - "properties": { - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The access type of the rule. Valid values are: 'Allow', 'Deny'." - }, - "routeFilterRuleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Community" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The rule type of the rule. Valid value is: 'Community'" - }, - "communities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']" - } - }, - "required": [ - "access", - "routeFilterRuleType", - "communities" - ], - "description": "Route Filter Rule Resource" - }, - "routeFilters_routeFilterRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "RoutePropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The destination CIDR to which the route applies." - }, - "nextHopType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VirtualNetworkGateway", - "VnetLocal", - "Internet", - "VirtualAppliance", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'." - }, - "nextHopIpAddress": { - "type": "string", - "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "nextHopType" - ], - "description": "Route resource" - }, - "RouteTable": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route table." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route table resource." - }, - "RouteTablePropertiesFormat": { - "type": "object", - "properties": { - "routes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Route" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of routes contained within a route table." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Route Table resource" - }, - "routeTables_routes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "SecurityRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Network security rule." - }, - "SecurityRulePropertiesFormat": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description for this rule. Restricted to 140 chars." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp", - "*" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'." - }, - "sourcePortRange": { - "type": "string", - "description": "The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "destinationPortRange": { - "type": "string", - "description": "The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "sourceAddressPrefix": { - "type": "string", - "description": "The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " - }, - "sourceAddressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CIDR or source IP ranges." - }, - "sourceApplicationSecurityGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationSecurityGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The application security group specified as source." - }, - "destinationAddressPrefix": { - "type": "string", - "description": "The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." - }, - "destinationAddressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The destination address prefixes. CIDR or destination IP ranges." - }, - "destinationApplicationSecurityGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationSecurityGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The application security group specified as destination." - }, - "sourcePortRanges": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source port ranges." - }, - "destinationPortRanges": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The destination port ranges." - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'." - }, - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "access", - "direction" - ], - "description": "Security rule resource." - }, - "ServiceEndpointPropertiesFormat": { - "type": "object", - "properties": { - "service": { - "type": "string", - "description": "The type of the endpoint service." - }, - "locations": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of locations." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "The service endpoint properties." - }, - "Subnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Subnet in a virtual network resource." - }, - "SubnetPropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The address prefix for the subnet." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "routeTable": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTable" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteTable resource." - }, - "serviceEndpoints": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceEndpointPropertiesFormat" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An array of service endpoints." - }, - "resourceNavigationLinks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceNavigationLink" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets an array of references to the external resources using subnet." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "Properties of the subnet." - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - } - }, - "description": "Reference to another subresource." - }, - "VirtualNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "VirtualNetworkGatewayConnectionPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorizationKey." - }, - "virtualNetworkGateway1": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to virtual network gateway resource." - }, - "virtualNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to virtual network gateway resource." - }, - "localNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to local network gateway resource." - }, - "connectionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPsec", - "Vnet2Vnet", - "ExpressRoute", - "VPNClient" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient." - }, - "routingWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The routing weight." - }, - "sharedKey": { - "type": "string", - "description": "The IPSec shared key." - }, - "peer": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to peerings resource." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp flag" - }, - "usePolicyBasedTrafficSelectors": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Enable policy-based traffic selectors." - }, - "ipsecPolicies": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IpsecPolicy" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Policies to be considered by this connection." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." - } - }, - "required": [ - "virtualNetworkGateway1", - "connectionType" - ], - "description": "VirtualNetworkGatewayConnection properties" - }, - "VirtualNetworkGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway ip configuration." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration for virtual network gateway" - }, - "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the public IP resource." - } - }, - "description": "Properties of VirtualNetworkGatewayIPConfiguration" - }, - "VirtualNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IP configurations for virtual network gateway." - }, - "gatewayType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Vpn", - "ExpressRoute" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PolicyBased", - "RouteBased" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether BGP is enabled for this virtual network gateway or not." - }, - "activeActive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "ActiveActive flag" - }, - "gatewayDefaultSite": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." - }, - "vpnClientConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGateway resource." - } - }, - "description": "VirtualNetworkGateway properties" - }, - "VirtualNetworkGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU name." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU tier." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity." - } - }, - "description": "VirtualNetworkGatewaySku details" - }, - "VirtualNetworkPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Peerings in a virtual network resource." - }, - "VirtualNetworkPeeringPropertiesFormat": { - "type": "object", - "properties": { - "allowVirtualNetworkAccess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space." - }, - "allowForwardedTraffic": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed." - }, - "allowGatewayTransit": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If gateway links can be used in remote virtual networking to link to this virtual network." - }, - "useRemoteGateways": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "remoteVirtualNetwork": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)." - }, - "remoteAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the remote virtual network address space." - }, - "peeringState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Initiated", - "Connected", - "Disconnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "Properties of the virtual network peering." - }, - "VirtualNetworkPropertiesFormat": { - "type": "object", - "properties": { - "addressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." - }, - "dhcpOptions": { - "oneOf": [ - { - "$ref": "#/definitions/DhcpOptions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of subnets in a Virtual Network." - }, - "virtualNetworkPeerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of peerings in a Virtual Network." - }, - "resourceGuid": { - "type": "string", - "description": "The resourceGuid property of the Virtual Network resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "enableDdosProtection": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network." - }, - "enableVmProtection": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if Vm protection is enabled for all the subnets in a Virtual Network." - } - }, - "description": "Properties of the virtual network." - }, - "virtualNetworks_subnets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-09-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - }, - "VpnClientConfiguration": { - "type": "object", - "properties": { - "vpnClientAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the address space resource which represents Address space for P2S VpnClient." - }, - "vpnClientRootCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRootCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRootCertificate for virtual network gateway." - }, - "vpnClientRevokedCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRevokedCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRevokedCertificate for Virtual network gateway." - }, - "vpnClientProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "IkeV2", - "SSTP" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientProtocols for Virtual network gateway." - }, - "radiusServerAddress": { - "type": "string", - "description": "The radius server address property of the VirtualNetworkGateway resource for vpn client connection." - }, - "radiusServerSecret": { - "type": "string", - "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection." - } - }, - "description": "VpnClientConfiguration for P2S client." - }, - "VpnClientRevokedCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the vpn client revoked certificate." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "VPN client revoked certificate of virtual network gateway." - }, - "VpnClientRevokedCertificatePropertiesFormat": { - "type": "object", - "properties": { - "thumbprint": { - "type": "string", - "description": "The revoked VPN client certificate thumbprint." - } - }, - "description": "Properties of the revoked VPN client certificate of virtual network gateway." - }, - "VpnClientRootCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the vpn client root certificate." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "VPN client root certificate of virtual network gateway" - }, - "VpnClientRootCertificatePropertiesFormat": { - "type": "object", - "properties": { - "publicCertData": { - "type": "string", - "description": "The certificate public data." - } - }, - "required": [ - "publicCertData" - ], - "description": "Properties of SSL certificates of application gateway" - } - } -} diff --git a/test/Resource/Expected/Network/2017-09-01/applicationGateways.md b/test/Resource/Expected/Network/2017-09-01/applicationGateways.md deleted file mode 100644 index 082bf41..0000000 --- a/test/Resource/Expected/Network/2017-09-01/applicationGateways.md +++ /dev/null @@ -1,1216 +0,0 @@ -# Microsoft.Network/applicationGateways template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/applicationGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationGateways", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "sslPolicy": { - "disabledSslProtocols": [ - "string" - ], - "policyType": "string", - "policyName": "string", - "cipherSuites": [ - "string" - ], - "minProtocolVersion": "string" - }, - "gatewayIPConfigurations": [ - { - "id": "string", - "properties": { - "subnet": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "authenticationCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "sslCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "password": "string", - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "frontendPorts": [ - { - "id": "string", - "properties": { - "port": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "host": "string", - "path": "string", - "interval": "integer", - "timeout": "integer", - "unhealthyThreshold": "integer", - "pickHostNameFromBackendHttpSettings": "boolean", - "minServers": "integer", - "match": { - "body": "string", - "statusCodes": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - "ApplicationGatewayBackendAddressPool" - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "applicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "backendHttpSettingsCollection": [ - { - "id": "string", - "properties": { - "port": "integer", - "protocol": "string", - "cookieBasedAffinity": "string", - "requestTimeout": "integer", - "probe": { - "id": "string" - }, - "authenticationCertificates": [ - { - "id": "string" - } - ], - "connectionDraining": { - "enabled": "boolean", - "drainTimeoutInSec": "integer" - }, - "hostName": "string", - "pickHostNameFromBackendAddress": "boolean", - "affinityCookieName": "string", - "probeEnabled": "boolean", - "path": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "httpListeners": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "frontendPort": { - "id": "string" - }, - "protocol": "string", - "hostName": "string", - "sslCertificate": { - "id": "string" - }, - "requireServerNameIndication": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "urlPathMaps": [ - { - "id": "string", - "properties": { - "defaultBackendAddressPool": { - "id": "string" - }, - "defaultBackendHttpSettings": { - "id": "string" - }, - "defaultRedirectConfiguration": { - "id": "string" - }, - "pathRules": [ - { - "id": "string", - "properties": { - "paths": [ - "string" - ], - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "redirectConfiguration": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "requestRoutingRules": [ - { - "id": "string", - "properties": { - "ruleType": "string", - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "httpListener": { - "id": "string" - }, - "urlPathMap": { - "id": "string" - }, - "redirectConfiguration": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "redirectConfigurations": [ - { - "id": "string", - "properties": { - "redirectType": "string", - "targetListener": { - "id": "string" - }, - "targetUrl": "string", - "includePath": "boolean", - "includeQueryString": "boolean", - "requestRoutingRules": [ - { - "id": "string" - } - ], - "urlPathMaps": [ - { - "id": "string" - } - ], - "pathRules": [ - { - "id": "string" - } - ] - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "webApplicationFirewallConfiguration": { - "enabled": "boolean", - "firewallMode": "string", - "ruleSetType": "string", - "ruleSetVersion": "string", - "disabledRuleGroups": [ - { - "ruleGroupName": "string", - "rules": [ - "integer" - ] - } - ] - }, - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationGateways | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [ApplicationGatewayPropertiesFormat object](#ApplicationGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | SKU of the application gateway resource. - [ApplicationGatewaySku object](#ApplicationGatewaySku) | -| sslPolicy | object | No | SSL policy of the application gateway resource. - [ApplicationGatewaySslPolicy object](#ApplicationGatewaySslPolicy) | -| gatewayIPConfigurations | array | No | Subnets of application the gateway resource. - [ApplicationGatewayIPConfiguration object](#ApplicationGatewayIPConfiguration) | -| authenticationCertificates | array | No | Authentication certificates of the application gateway resource. - [ApplicationGatewayAuthenticationCertificate object](#ApplicationGatewayAuthenticationCertificate) | -| sslCertificates | array | No | SSL certificates of the application gateway resource. - [ApplicationGatewaySslCertificate object](#ApplicationGatewaySslCertificate) | -| frontendIPConfigurations | array | No | Frontend IP addresses of the application gateway resource. - [ApplicationGatewayFrontendIPConfiguration object](#ApplicationGatewayFrontendIPConfiguration) | -| frontendPorts | array | No | Frontend ports of the application gateway resource. - [ApplicationGatewayFrontendPort object](#ApplicationGatewayFrontendPort) | -| probes | array | No | Probes of the application gateway resource. - [ApplicationGatewayProbe object](#ApplicationGatewayProbe) | -| backendAddressPools | array | No | Backend address pool of the application gateway resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| backendHttpSettingsCollection | array | No | Backend http settings of the application gateway resource. - [ApplicationGatewayBackendHttpSettings object](#ApplicationGatewayBackendHttpSettings) | -| httpListeners | array | No | Http listeners of the application gateway resource. - [ApplicationGatewayHttpListener object](#ApplicationGatewayHttpListener) | -| urlPathMaps | array | No | URL path map of the application gateway resource. - [ApplicationGatewayUrlPathMap object](#ApplicationGatewayUrlPathMap) | -| requestRoutingRules | array | No | Request routing rules of the application gateway resource. - [ApplicationGatewayRequestRoutingRule object](#ApplicationGatewayRequestRoutingRule) | -| redirectConfigurations | array | No | Redirect configurations of the application gateway resource. - [ApplicationGatewayRedirectConfiguration object](#ApplicationGatewayRedirectConfiguration) | -| webApplicationFirewallConfiguration | object | No | Web application firewall configuration. - [ApplicationGatewayWebApplicationFirewallConfiguration object](#ApplicationGatewayWebApplicationFirewallConfiguration) | -| resourceGuid | string | No | Resource GUID property of the application gateway resource. | -| provisioningState | string | No | Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of an application gateway SKU. - Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large | -| tier | enum | No | Tier of an application gateway. - Standard or WAF | -| capacity | integer | No | Capacity (instance count) of an application gateway. | - - - -### ApplicationGatewaySslPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disabledSslProtocols | array | No | Ssl protocols to be disabled on application gateway. - TLSv1_0, TLSv1_1, TLSv1_2 | -| policyType | enum | No | Type of Ssl Policy. - Predefined or Custom | -| policyName | enum | No | Name of Ssl predefined policy. - AppGwSslPolicy20150501, AppGwSslPolicy20170401, AppGwSslPolicy20170401S | -| cipherSuites | array | No | Ssl cipher suites to be enabled in the specified order to application gateway. - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA | -| minProtocolVersion | enum | No | Minimum version of Ssl protocol to be supported on application gateway. - TLSv1_0, TLSv1_1, TLSv1_2 | - - - -### ApplicationGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayIPConfigurationPropertiesFormat object](#ApplicationGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayAuthenticationCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayAuthenticationCertificatePropertiesFormat object](#ApplicationGatewayAuthenticationCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewaySslCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewaySslCertificatePropertiesFormat object](#ApplicationGatewaySslCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayFrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendIPConfigurationPropertiesFormat object](#ApplicationGatewayFrontendIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayFrontendPort object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendPortPropertiesFormat object](#ApplicationGatewayFrontendPortPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayProbe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayProbePropertiesFormat object](#ApplicationGatewayProbePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayBackendHttpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendHttpSettingsPropertiesFormat object](#ApplicationGatewayBackendHttpSettingsPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayHttpListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayHttpListenerPropertiesFormat object](#ApplicationGatewayHttpListenerPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayUrlPathMap object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayUrlPathMapPropertiesFormat object](#ApplicationGatewayUrlPathMapPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayRequestRoutingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRequestRoutingRulePropertiesFormat object](#ApplicationGatewayRequestRoutingRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayRedirectConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRedirectConfigurationPropertiesFormat object](#ApplicationGatewayRedirectConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayWebApplicationFirewallConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether the web application firewall is enabled or not. | -| firewallMode | enum | Yes | Web application firewall mode. - Detection or Prevention | -| ruleSetType | string | Yes | The type of the web application firewall rule set. Possible values are: 'OWASP'. | -| ruleSetVersion | string | Yes | The version of the rule set type. | -| disabledRuleGroups | array | No | The disabled rule groups. - [ApplicationGatewayFirewallDisabledRuleGroup object](#ApplicationGatewayFirewallDisabledRuleGroup) | - - - -### ApplicationGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Reference of the subnet resource. A subnet from where application gateway gets its private address. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayAuthenticationCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Certificate public data. | -| provisioningState | string | No | Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySslCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Base-64 encoded pfx certificate. Only applicable in PUT Request. | -| password | string | No | Password for the pfx file specified in data. Only applicable in PUT request. | -| publicCertData | string | No | Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. | -| provisioningState | string | No | Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | PrivateIPAddress of the network interface IP Configuration. | -| privateIPAllocationMethod | enum | No | PrivateIP allocation method. - Static or Dynamic | -| subnet | object | No | Reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Reference of the PublicIP resource. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendPortPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Frontend port | -| provisioningState | string | No | Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol. - Http or Https | -| host | string | No | Host name to send the probe to. | -| path | string | No | Relative path of probe. Valid path starts from '/'. Probe is sent to ://: | -| interval | integer | No | The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. | -| timeout | integer | No | 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 | integer | No | The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. | -| pickHostNameFromBackendHttpSettings | boolean | No | Whether the host header should be picked from the backend http settings. Default value is false. | -| minServers | integer | No | Minimum number of servers that are always marked healthy. Default value is 0. | -| match | object | No | Criterion for classifying a healthy probe response. - [ApplicationGatewayProbeHealthResponseMatch object](#ApplicationGatewayProbeHealthResponseMatch) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendHttpSettingsPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Port | -| protocol | enum | No | Protocol. - Http or Https | -| cookieBasedAffinity | enum | No | Cookie based affinity. - Enabled or Disabled | -| requestTimeout | integer | No | 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. | -| probe | object | No | Probe resource of an application gateway. - [SubResource object](#SubResource) | -| authenticationCertificates | array | No | Array of references to application gateway authentication certificates. - [SubResource object](#SubResource) | -| connectionDraining | object | No | Connection draining of the backend http settings resource. - [ApplicationGatewayConnectionDraining object](#ApplicationGatewayConnectionDraining) | -| hostName | string | No | Host header to be sent to the backend servers. | -| pickHostNameFromBackendAddress | boolean | No | Whether to pick host header should be picked from the host name of the backend server. Default value is false. | -| affinityCookieName | string | No | Cookie name to use for the affinity cookie. | -| probeEnabled | boolean | No | Whether the probe is enabled. Default value is false. | -| path | string | No | Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayHttpListenerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Frontend IP configuration resource of an application gateway. - [SubResource object](#SubResource) | -| frontendPort | object | No | Frontend port resource of an application gateway. - [SubResource object](#SubResource) | -| protocol | enum | No | Protocol. - Http or Https | -| hostName | string | No | Host name of HTTP listener. | -| sslCertificate | object | No | SSL certificate resource of an application gateway. - [SubResource object](#SubResource) | -| requireServerNameIndication | boolean | No | Applicable only if protocol is https. Enables SNI for multi-hosting. | -| provisioningState | string | No | Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayUrlPathMapPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultBackendAddressPool | object | No | Default backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| defaultBackendHttpSettings | object | No | Default backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| defaultRedirectConfiguration | object | No | Default redirect configuration resource of URL path map. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rule of URL path map resource. - [ApplicationGatewayPathRule object](#ApplicationGatewayPathRule) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRequestRoutingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleType | enum | No | Rule type. - Basic or PathBasedRouting | -| backendAddressPool | object | No | Backend address pool resource of the application gateway. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Frontend port resource of the application gateway. - [SubResource object](#SubResource) | -| httpListener | object | No | Http listener resource of the application gateway. - [SubResource object](#SubResource) | -| urlPathMap | object | No | URL path map resource of the application gateway. - [SubResource object](#SubResource) | -| redirectConfiguration | object | No | Redirect configuration resource of the application gateway. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRedirectConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| redirectType | enum | No | Supported http redirection types - Permanent, Temporary, Found, SeeOther. - Permanent, Found, SeeOther, Temporary | -| targetListener | object | No | Reference to a listener to redirect the request to. - [SubResource object](#SubResource) | -| targetUrl | string | No | Url to redirect the request to. | -| includePath | boolean | No | Include path in the redirected url. | -| includeQueryString | boolean | No | Include query string in the redirected url. | -| requestRoutingRules | array | No | Request routing specifying redirect configuration. - [SubResource object](#SubResource) | -| urlPathMaps | array | No | Url path maps specifying default redirect configuration. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rules specifying redirect configuration. - [SubResource object](#SubResource) | - - - -### ApplicationGatewayFirewallDisabledRuleGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleGroupName | string | Yes | The name of the rule group that will be disabled. | -| rules | array | No | The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - integer | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### ApplicationGatewayProbeHealthResponseMatch object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| body | string | No | Body that must be contained in the health response. Default value is empty. | -| statusCodes | array | No | Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - string | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Network interface IP configuration properties. - [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### ApplicationGatewayConnectionDraining object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether connection draining is enabled or not. | -| drainTimeoutInSec | integer | Yes | The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. | - - - -### ApplicationGatewayPathRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayPathRulePropertiesFormat object](#ApplicationGatewayPathRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | Private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | Subnet bound to the IP configuration. - [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | Public IP address bound to the IP configuration. - [PublicIPAddress object](#PublicIPAddress) | -| applicationSecurityGroups | array | No | Application security groups in which the IP configuration is included. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| provisioningState | string | No | The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayPathRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| paths | array | No | Path rules of URL path map. - string | -| backendAddressPool | object | No | Backend address pool resource of URL path map path rule. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Backend http settings resource of URL path map path rule. - [SubResource object](#SubResource) | -| redirectConfiguration | object | No | Redirect configuration resource of URL path map path rule. - [SubResource object](#SubResource) | -| provisioningState | string | No | Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | Udp, Tcp, All | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-09-01/applicationSecurityGroups.md b/test/Resource/Expected/Network/2017-09-01/applicationSecurityGroups.md deleted file mode 100644 index ad61ae0..0000000 --- a/test/Resource/Expected/Network/2017-09-01/applicationSecurityGroups.md +++ /dev/null @@ -1,33 +0,0 @@ -# Microsoft.Network/applicationSecurityGroups template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/applicationSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationSecurityGroups", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationSecurityGroups | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-09-01/connections.md b/test/Resource/Expected/Network/2017-09-01/connections.md deleted file mode 100644 index 45c1290..0000000 --- a/test/Resource/Expected/Network/2017-09-01/connections.md +++ /dev/null @@ -1,403 +0,0 @@ -# Microsoft.Network/connections template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/connections", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "authorizationKey": "string", - "virtualNetworkGateway1": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "virtualNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "localNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "connectionType": "string", - "routingWeight": "integer", - "sharedKey": "string", - "peer": { - "id": "string" - }, - "enableBgp": "boolean", - "usePolicyBasedTrafficSelectors": "boolean", - "ipsecPolicies": [ - { - "saLifeTimeSeconds": "integer", - "saDataSizeKilobytes": "integer", - "ipsecEncryption": "string", - "ipsecIntegrity": "string", - "ikeEncryption": "string", - "ikeIntegrity": "string", - "dhGroup": "string", - "pfsGroup": "string" - } - ], - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/connections | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway connection. - [VirtualNetworkGatewayConnectionPropertiesFormat object](#VirtualNetworkGatewayConnectionPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayConnectionPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorizationKey. | -| virtualNetworkGateway1 | object | Yes | The reference to virtual network gateway resource. - [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| virtualNetworkGateway2 | object | No | The reference to virtual network gateway resource. - [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| localNetworkGateway2 | object | No | The reference to local network gateway resource. - [LocalNetworkGateway object](#LocalNetworkGateway) | -| connectionType | enum | Yes | Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. - IPsec, Vnet2Vnet, ExpressRoute, VPNClient | -| routingWeight | integer | No | The routing weight. | -| sharedKey | string | No | The IPSec shared key. | -| peer | object | No | The reference to peerings resource. - [SubResource object](#SubResource) | -| enableBgp | boolean | No | EnableBgp flag | -| usePolicyBasedTrafficSelectors | boolean | No | Enable policy-based traffic selectors. | -| ipsecPolicies | array | No | The IPSec Policies to be considered by this connection. - [IpsecPolicy object](#IpsecPolicy) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGatewayConnection resource. | - - - -### VirtualNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway. - [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the local network gateway. - [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### IpsecPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| saLifeTimeSeconds | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. | -| saDataSizeKilobytes | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. | -| ipsecEncryption | enum | Yes | The IPSec encryption algorithm (IKE phase 1). - None, DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256 | -| ipsecIntegrity | enum | Yes | The IPSec integrity algorithm (IKE phase 1). - MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256 | -| ikeEncryption | enum | Yes | The IKE encryption algorithm (IKE phase 2). - DES, DES3, AES128, AES192, AES256 | -| ikeIntegrity | enum | Yes | The IKE integrity algorithm (IKE phase 2). - MD5, SHA1, SHA256, SHA384 | -| dhGroup | enum | Yes | The DH Groups used in IKE Phase 1 for initial SA. - None, DHGroup1, DHGroup2, DHGroup14, DHGroup2048, ECP256, ECP384, DHGroup24 | -| pfsGroup | enum | Yes | The DH Groups used in IKE Phase 2 for new child SA. - None, PFS1, PFS2, PFS2048, ECP256, ECP384, PFS24 | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network gateway ip configuration. - [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | -| vpnClientProtocols | array | No | VpnClientProtocols for Virtual network gateway. - IkeV2 or SSTP | -| radiusServerAddress | string | No | The radius server address property of the VirtualNetworkGateway resource for vpn client connection. | -| radiusServerSecret | string | No | The radius secret property of the VirtualNetworkGateway resource for vpn client connection. | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the vpn client root certificate. - [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the vpn client revoked certificate. - [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-09-01/expressRouteCircuits.md b/test/Resource/Expected/Network/2017-09-01/expressRouteCircuits.md deleted file mode 100644 index 0178fde..0000000 --- a/test/Resource/Expected/Network/2017-09-01/expressRouteCircuits.md +++ /dev/null @@ -1,326 +0,0 @@ -# Microsoft.Network/expressRouteCircuits template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "family": "string" - }, - "properties": { - "allowClassicOperations": "boolean", - "circuitProvisioningState": "string", - "serviceProviderProvisioningState": "string", - "authorizations": [ - { - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "name": "string" - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - "ExpressRouteCircuitPeering" - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - "ExpressRouteCircuitPeering" - ] - } - }, - "state": "string" - } - }, - "name": "string" - } - ], - "serviceKey": "string", - "serviceProviderNotes": "string", - "serviceProviderProperties": { - "serviceProviderName": "string", - "peeringLocation": "string", - "bandwidthInMbps": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The SKU. - [ExpressRouteCircuitSku object](#ExpressRouteCircuitSku) | -| properties | object | Yes | [ExpressRouteCircuitPropertiesFormat object](#ExpressRouteCircuitPropertiesFormat) | -| resources | array | No | [peerings](./expressRouteCircuits/peerings.md) [authorizations](./expressRouteCircuits/authorizations.md) | - - - -### ExpressRouteCircuitSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the SKU. | -| tier | enum | No | The tier of the SKU. Possible values are 'Standard' and 'Premium'. - Standard or Premium | -| family | enum | No | The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. - UnlimitedData or MeteredData | - - - -### ExpressRouteCircuitPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowClassicOperations | boolean | No | Allow classic operations | -| circuitProvisioningState | string | No | The CircuitProvisioningState state of the resource. | -| serviceProviderProvisioningState | enum | No | The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - NotProvisioned, Provisioning, Provisioned, Deprovisioning | -| authorizations | array | No | The list of authorizations. - [ExpressRouteCircuitAuthorization object](#ExpressRouteCircuitAuthorization) | -| peerings | array | No | The list of peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | -| serviceKey | string | No | The ServiceKey. | -| serviceProviderNotes | string | No | The ServiceProviderNotes. | -| serviceProviderProperties | object | No | The ServiceProviderProperties. - [ExpressRouteCircuitServiceProviderProperties object](#ExpressRouteCircuitServiceProviderProperties) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | - - - -### ExpressRouteCircuitAuthorization object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitServiceProviderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceProviderName | string | No | The serviceProviderName. | -| peeringLocation | string | No | The peering location. | -| bandwidthInMbps | integer | No | The BandwidthInMbps. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-09-01/expressRouteCircuits/authorizations.md b/test/Resource/Expected/Network/2017-09-01/expressRouteCircuits/authorizations.md deleted file mode 100644 index e04dfbc..0000000 --- a/test/Resource/Expected/Network/2017-09-01/expressRouteCircuits/authorizations.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/authorizations template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/authorizations", - "apiVersion": "2017-09-01", - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/authorizations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/authorizations | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-09-01/expressRouteCircuits/peerings.md b/test/Resource/Expected/Network/2017-09-01/expressRouteCircuits/peerings.md deleted file mode 100644 index d19e8e8..0000000 --- a/test/Resource/Expected/Network/2017-09-01/expressRouteCircuits/peerings.md +++ /dev/null @@ -1,239 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/peerings template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/peerings", - "apiVersion": "2017-09-01", - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": "ExpressRouteCircuitPeeringPropertiesFormat", - "name": "string" - } - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": "ExpressRouteCircuitPeeringPropertiesFormat", - "name": "string" - } - ] - } - }, - "state": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/peerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/peerings | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-09-01/loadBalancers.md b/test/Resource/Expected/Network/2017-09-01/loadBalancers.md deleted file mode 100644 index 9c5a3a5..0000000 --- a/test/Resource/Expected/Network/2017-09-01/loadBalancers.md +++ /dev/null @@ -1,717 +0,0 @@ -# Microsoft.Network/loadBalancers template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/loadBalancers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "zones": [ - "string" - ] - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendAddressPool": { - "id": "string" - }, - "probe": { - "id": "string" - }, - "protocol": "string", - "loadDistribution": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "disableOutboundSnat": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "port": "integer", - "intervalInSeconds": "integer", - "numberOfProbes": "integer", - "requestPath": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatPools": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "backendPort": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "outboundNatRules": [ - { - "id": "string", - "properties": { - "allocatedOutboundPorts": "integer", - "frontendIPConfigurations": [ - { - "id": "string" - } - ], - "backendAddressPool": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The load balancer SKU. - [LoadBalancerSku object](#LoadBalancerSku) | -| properties | object | Yes | Properties of load balancer. - [LoadBalancerPropertiesFormat object](#LoadBalancerPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [inboundNatRules](./loadBalancers/inboundNatRules.md) | - - - -### LoadBalancerSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a load balancer SKU. - Basic or Standard | - - - -### LoadBalancerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfigurations | array | No | Object representing the frontend IPs to be used for the load balancer - [FrontendIPConfiguration object](#FrontendIPConfiguration) | -| backendAddressPools | array | No | Collection of backend address pools used by a load balancer - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancingRules | array | No | Object collection representing the load balancing rules Gets the provisioning - [LoadBalancingRule object](#LoadBalancingRule) | -| probes | array | No | Collection of probe objects used in the load balancer - [Probe object](#Probe) | -| inboundNatRules | array | No | 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. - [InboundNatRule object](#InboundNatRule) | -| inboundNatPools | array | No | 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. - [InboundNatPool object](#InboundNatPool) | -| outboundNatRules | array | No | The outbound NAT rules. - [OutboundNatRule object](#OutboundNatRule) | -| resourceGuid | string | No | The resource GUID property of the load balancer resource. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### FrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the load balancer probe. - [FrontendIPConfigurationPropertiesFormat object](#FrontendIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer load balancing rule. - [LoadBalancingRulePropertiesFormat object](#LoadBalancingRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Probe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer probe. - [ProbePropertiesFormat object](#ProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat pool. - [InboundNatPoolPropertiesFormat object](#InboundNatPoolPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### OutboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer outbound nat rule. - [OutboundNatRulePropertiesFormat object](#OutboundNatRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### FrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | The private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [Subnet object](#Subnet) | -| publicIPAddress | object | No | The reference of the Public IP resource. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### LoadBalancingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| backendAddressPool | object | No | A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| probe | object | No | The reference of the load balancer probe used by the load balancing rule. - [SubResource object](#SubResource) | -| protocol | enum | Yes | Udp, Tcp, All | -| loadDistribution | enum | No | The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. - Default, SourceIP, SourceIPProtocol | -| frontendPort | integer | Yes | 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" | -| backendPort | integer | No | The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| disableOutboundSnat | boolean | No | Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | Yes | 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. - Http or Tcp | -| port | integer | Yes | The port for communicating the probe. Possible values range from 1 to 65535, inclusive. | -| intervalInSeconds | integer | No | 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. | -| numberOfProbes | integer | No | 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. | -| requestPath | string | No | 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. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | Udp, Tcp, All | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | Yes | Udp, Tcp, All | -| frontendPortRangeStart | integer | Yes | 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. | -| frontendPortRangeEnd | integer | Yes | 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. | -| backendPort | integer | Yes | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### OutboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allocatedOutboundPorts | integer | No | The number of outbound ports to be used for NAT. | -| frontendIPConfigurations | array | No | The Frontend IP addresses of the load balancer. - [SubResource object](#SubResource) | -| backendAddressPool | object | Yes | A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-09-01/loadBalancers/inboundNatRules.md b/test/Resource/Expected/Network/2017-09-01/loadBalancers/inboundNatRules.md deleted file mode 100644 index 8f3411a..0000000 --- a/test/Resource/Expected/Network/2017-09-01/loadBalancers/inboundNatRules.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/loadBalancers/inboundNatRules template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/loadBalancers/inboundNatRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers/inboundNatRules", - "apiVersion": "2017-09-01", - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers/inboundNatRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers/inboundNatRules | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | Udp, Tcp, All | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - diff --git a/test/Resource/Expected/Network/2017-09-01/localNetworkGateways.md b/test/Resource/Expected/Network/2017-09-01/localNetworkGateways.md deleted file mode 100644 index b931025..0000000 --- a/test/Resource/Expected/Network/2017-09-01/localNetworkGateways.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/localNetworkGateways template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/localNetworkGateways", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/localNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/localNetworkGateways | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the local network gateway. - [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - diff --git a/test/Resource/Expected/Network/2017-09-01/networkInterfaces.md b/test/Resource/Expected/Network/2017-09-01/networkInterfaces.md deleted file mode 100644 index 2fe2424..0000000 --- a/test/Resource/Expected/Network/2017-09-01/networkInterfaces.md +++ /dev/null @@ -1,730 +0,0 @@ -# Microsoft.Network/networkInterfaces template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/networkInterfaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkInterfaces", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "applicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableAcceleratedNetworking": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkInterfaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkInterfaces | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the network interface. - [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | The reference of a virtual machine. - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | A list of IPConfigurations of the network interface. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | The DNS settings in network interface. - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | The MAC address of the network interface. | -| primary | boolean | No | Gets whether this is a primary network interface on a virtual machine. | -| enableAcceleratedNetworking | boolean | No | If the network interface is accelerated networking enabled. | -| enableIPForwarding | boolean | No | Indicates whether IP forwarding is enabled on this network interface. | -| resourceGuid | string | No | The resource GUID property of the network interface resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Network interface IP configuration properties. - [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | 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. - string | -| appliedDnsServers | array | No | 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. - string | -| internalDnsNameLabel | string | No | Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. | -| internalFqdn | string | No | Fully qualified DNS name supporting internal communications between VMs in the same virtual network. | -| internalDomainNameSuffix | string | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | Private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | Subnet bound to the IP configuration. - [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | Public IP address bound to the IP configuration. - [PublicIPAddress object](#PublicIPAddress) | -| applicationSecurityGroups | array | No | Application security groups in which the IP configuration is included. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| provisioningState | string | No | The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | Udp, Tcp, All | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-09-01/networkSecurityGroups.md b/test/Resource/Expected/Network/2017-09-01/networkSecurityGroups.md deleted file mode 100644 index e77e4b0..0000000 --- a/test/Resource/Expected/Network/2017-09-01/networkSecurityGroups.md +++ /dev/null @@ -1,186 +0,0 @@ -# Microsoft.Network/networkSecurityGroups template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [securityRules](./networkSecurityGroups/securityRules.md) | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-09-01/networkSecurityGroups/securityRules.md b/test/Resource/Expected/Network/2017-09-01/networkSecurityGroups/securityRules.md deleted file mode 100644 index 037fc58..0000000 --- a/test/Resource/Expected/Network/2017-09-01/networkSecurityGroups/securityRules.md +++ /dev/null @@ -1,102 +0,0 @@ -# Microsoft.Network/networkSecurityGroups/securityRules template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups/securityRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups/securityRules", - "apiVersion": "2017-09-01", - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups/securityRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups/securityRules | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-09-01/networkWatchers.md b/test/Resource/Expected/Network/2017-09-01/networkWatchers.md deleted file mode 100644 index 40c9504..0000000 --- a/test/Resource/Expected/Network/2017-09-01/networkWatchers.md +++ /dev/null @@ -1,37 +0,0 @@ -# Microsoft.Network/networkWatchers template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/networkWatchers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "etag": "string", - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| properties | object | Yes | [NetworkWatcherPropertiesFormat object](#NetworkWatcherPropertiesFormat) | -| resources | array | No | [packetCaptures](./networkWatchers/packetCaptures.md) | - diff --git a/test/Resource/Expected/Network/2017-09-01/networkWatchers/packetCaptures.md b/test/Resource/Expected/Network/2017-09-01/networkWatchers/packetCaptures.md deleted file mode 100644 index f8bb0d7..0000000 --- a/test/Resource/Expected/Network/2017-09-01/networkWatchers/packetCaptures.md +++ /dev/null @@ -1,78 +0,0 @@ -# Microsoft.Network/networkWatchers/packetCaptures template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers/packetCaptures", - "apiVersion": "2017-09-01", - "properties": { - "target": "string", - "bytesToCapturePerPacket": "integer", - "totalBytesPerSession": "integer", - "timeLimitInSeconds": "integer", - "storageLocation": { - "storageId": "string", - "storagePath": "string", - "filePath": "string" - }, - "filters": [ - { - "protocol": "string", - "localIPAddress": "string", - "remoteIPAddress": "string", - "localPort": "string", - "remotePort": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers/packetCaptures object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers/packetCaptures | -| apiVersion | enum | Yes | 2017-09-01 | -| properties | object | Yes | [PacketCaptureParameters object](#PacketCaptureParameters) | - - - -### PacketCaptureParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| target | string | Yes | The ID of the targeted resource, only VM is currently supported. | -| bytesToCapturePerPacket | integer | No | Number of bytes captured per packet, the remaining bytes are truncated. | -| totalBytesPerSession | integer | No | Maximum size of the capture output. | -| timeLimitInSeconds | integer | No | Maximum duration of the capture session in seconds. | -| storageLocation | object | Yes | [PacketCaptureStorageLocation object](#PacketCaptureStorageLocation) | -| filters | array | No | [PacketCaptureFilter object](#PacketCaptureFilter) | - - - -### PacketCaptureStorageLocation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageId | string | No | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | -| storagePath | string | No | 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. | -| filePath | string | No | 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. | - - - -### PacketCaptureFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol to be filtered on. - TCP, UDP, Any | -| localIPAddress | string | No | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | -| remoteIPAddress | string | No | 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 | No | 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. | -| remotePort | string | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-09-01/publicIPAddresses.md b/test/Resource/Expected/Network/2017-09-01/publicIPAddresses.md deleted file mode 100644 index ed72026..0000000 --- a/test/Resource/Expected/Network/2017-09-01/publicIPAddresses.md +++ /dev/null @@ -1,84 +0,0 @@ -# Microsoft.Network/publicIPAddresses template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/publicIPAddresses", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/publicIPAddresses object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/publicIPAddresses | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | Yes | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-09-01/routeFilters.md b/test/Resource/Expected/Network/2017-09-01/routeFilters.md deleted file mode 100644 index f378d08..0000000 --- a/test/Resource/Expected/Network/2017-09-01/routeFilters.md +++ /dev/null @@ -1,222 +0,0 @@ -# Microsoft.Network/routeFilters template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/routeFilters resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "RouteFilterPropertiesFormat" - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "RouteFilterPropertiesFormat" - }, - "state": "string" - } - }, - "name": "string" - } - ] - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | -| resources | array | No | [routeFilterRules](./routeFilters/routeFilterRules.md) | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - diff --git a/test/Resource/Expected/Network/2017-09-01/routeFilters/routeFilterRules.md b/test/Resource/Expected/Network/2017-09-01/routeFilters/routeFilterRules.md deleted file mode 100644 index e971287..0000000 --- a/test/Resource/Expected/Network/2017-09-01/routeFilters/routeFilterRules.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.Network/routeFilters/routeFilterRules template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/routeFilters/routeFilterRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters/routeFilterRules", - "apiVersion": "2017-09-01", - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters/routeFilterRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters/routeFilterRules | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-09-01/routeTables.md b/test/Resource/Expected/Network/2017-09-01/routeTables.md deleted file mode 100644 index 60af32e..0000000 --- a/test/Resource/Expected/Network/2017-09-01/routeTables.md +++ /dev/null @@ -1,80 +0,0 @@ -# Microsoft.Network/routeTables template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/routeTables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [routes](./routeTables/routes.md) | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-09-01/routeTables/routes.md b/test/Resource/Expected/Network/2017-09-01/routeTables/routes.md deleted file mode 100644 index b0b0b4c..0000000 --- a/test/Resource/Expected/Network/2017-09-01/routeTables/routes.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Network/routeTables/routes template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/routeTables/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables/routes", - "apiVersion": "2017-09-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables/routes | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-09-01/virtualNetworkGateways.md b/test/Resource/Expected/Network/2017-09-01/virtualNetworkGateways.md deleted file mode 100644 index e6fd33e..0000000 --- a/test/Resource/Expected/Network/2017-09-01/virtualNetworkGateways.md +++ /dev/null @@ -1,215 +0,0 @@ -# Microsoft.Network/virtualNetworkGateways template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/virtualNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworkGateways", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworkGateways | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway. - [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network gateway ip configuration. - [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | -| vpnClientProtocols | array | No | VpnClientProtocols for Virtual network gateway. - IkeV2 or SSTP | -| radiusServerAddress | string | No | The radius server address property of the VirtualNetworkGateway resource for vpn client connection. | -| radiusServerSecret | string | No | The radius secret property of the VirtualNetworkGateway resource for vpn client connection. | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the vpn client root certificate. - [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the vpn client revoked certificate. - [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-09-01/virtualNetworks.md b/test/Resource/Expected/Network/2017-09-01/virtualNetworks.md deleted file mode 100644 index f484410..0000000 --- a/test/Resource/Expected/Network/2017-09-01/virtualNetworks.md +++ /dev/null @@ -1,440 +0,0 @@ -# Microsoft.Network/virtualNetworks template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/virtualNetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks", - "apiVersion": "2017-09-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "addressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "string" - ] - }, - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "virtualNetworkPeerings": [ - { - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "remoteAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "peeringState": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string", - "enableDdosProtection": "boolean", - "enableVmProtection": "boolean" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network. - [VirtualNetworkPropertiesFormat object](#VirtualNetworkPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [virtualNetworkPeerings](./virtualNetworks/virtualNetworkPeerings.md) [subnets](./virtualNetworks/subnets.md) | - - - -### VirtualNetworkPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressSpace | object | No | The AddressSpace that contains an array of IP address ranges that can be used by subnets. - [AddressSpace object](#AddressSpace) | -| dhcpOptions | object | No | The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. - [DhcpOptions object](#DhcpOptions) | -| subnets | array | No | A list of subnets in a Virtual Network. - [Subnet object](#Subnet) | -| virtualNetworkPeerings | array | No | A list of peerings in a Virtual Network. - [VirtualNetworkPeering object](#VirtualNetworkPeering) | -| resourceGuid | string | No | The resourceGuid property of the Virtual Network resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| enableDdosProtection | boolean | No | Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. | -| enableVmProtection | boolean | No | Indicates if Vm protection is enabled for all the subnets in a Virtual Network. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### DhcpOptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | The list of DNS servers IP addresses. - string | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network peering. - [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). - [SubResource object](#SubResource) | -| remoteAddressSpace | object | No | The reference of the remote virtual network address space. - [AddressSpace object](#AddressSpace) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-09-01/virtualNetworks/subnets.md b/test/Resource/Expected/Network/2017-09-01/virtualNetworks/subnets.md deleted file mode 100644 index f00975c..0000000 --- a/test/Resource/Expected/Network/2017-09-01/virtualNetworks/subnets.md +++ /dev/null @@ -1,319 +0,0 @@ -# Microsoft.Network/virtualNetworks/subnets template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/subnets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/subnets", - "apiVersion": "2017-09-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/subnets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/subnets | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-09-01/virtualNetworks/virtualNetworkPeerings.md b/test/Resource/Expected/Network/2017-09-01/virtualNetworks/virtualNetworkPeerings.md deleted file mode 100644 index 3bbf024..0000000 --- a/test/Resource/Expected/Network/2017-09-01/virtualNetworks/virtualNetworkPeerings.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/virtualNetworks/virtualNetworkPeerings template reference -API Version: 2017-09-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/virtualNetworkPeerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings", - "apiVersion": "2017-09-01", - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "remoteAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "peeringState": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/virtualNetworkPeerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/virtualNetworkPeerings | -| apiVersion | enum | Yes | 2017-09-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the virtual network peering. - [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). - [SubResource object](#SubResource) | -| remoteAddressSpace | object | No | The reference of the remote virtual network address space. - [AddressSpace object](#AddressSpace) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - diff --git a/test/Resource/Expected/Network/2017-10-01/Microsoft.Network.json b/test/Resource/Expected/Network/2017-10-01/Microsoft.Network.json deleted file mode 100644 index edbfe18..0000000 --- a/test/Resource/Expected/Network/2017-10-01/Microsoft.Network.json +++ /dev/null @@ -1,7706 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-10-01/Microsoft.Network.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Network", - "description": "Microsoft Network Resource Types", - "resourceDefinitions": { - "applicationGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationGateways" - }, - "applicationSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/applicationSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the application security group." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/applicationSecurityGroups" - }, - "connections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/connections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway connection." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/connections" - }, - "expressRouteCircuits": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/expressRouteCircuits_authorizations_childResource" - }, - { - "$ref": "#/definitions/expressRouteCircuits_peerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits" - }, - "expressRouteCircuits_authorizations": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/expressRouteCircuits/peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "loadBalancers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load balancer SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/loadBalancers_inboundNatRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers" - }, - "loadBalancers_inboundNatRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/loadBalancers/inboundNatRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers/inboundNatRules" - }, - "localNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/localNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the local network gateway." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/localNetworkGateways" - }, - "networkInterfaces": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkInterfaces" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfacePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network interface." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkInterfaces" - }, - "networkSecurityGroups": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network security group" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkSecurityGroups_securityRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups" - }, - "networkSecurityGroups_securityRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkSecurityGroups/securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "networkWatchers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkWatcherPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/networkWatchers_packetCaptures_childResource" - }, - { - "$ref": "#/definitions/networkWatchers_connectionMonitors_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers" - }, - "networkWatchers_connectionMonitors": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers/connectionMonitors" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "location": { - "type": "string", - "description": "Connection monitor location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connection monitor tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectionMonitorParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/connectionMonitors" - }, - "networkWatchers_packetCaptures": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/networkWatchers/packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "publicIPAddresses": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/publicIPAddresses" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address properties." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/publicIPAddresses" - }, - "routeFilters": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeFilters_routeFilterRules_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters" - }, - "routeFilters_routeFilterRules": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeFilters/routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "routeTables": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route table." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/routeTables_routes_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables" - }, - "routeTables_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/routeTables/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "virtualNetworkGateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworkGateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworkGateways" - }, - "virtualNetworks": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualNetworks_subnets_childResource" - }, - { - "$ref": "#/definitions/virtualNetworks_virtualNetworkPeerings_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks" - }, - "virtualNetworks_subnets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - } - }, - "definitions": { - "AddressSpace": { - "type": "object", - "properties": { - "addressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of address blocks reserved for this virtual network in CIDR notation." - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." - }, - "ApplicationGatewayAuthenticationCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Authentication certificates of an application gateway." - }, - "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Certificate public data." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Authentication certificates properties of an application gateway." - }, - "ApplicationGatewayBackendAddress": { - "type": "object", - "properties": { - "fqdn": { - "type": "string", - "description": "Fully qualified domain name (FQDN)." - }, - "ipAddress": { - "type": "string", - "description": "IP address" - } - }, - "description": "Backend address of an application gateway." - }, - "ApplicationGatewayBackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "backendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of references to IPs defined in network interfaces." - }, - "backendAddresses": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddress" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend addresses" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend Address Pool of an application gateway." - }, - "ApplicationGatewayBackendHttpSettings": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Backend address pool settings of an application gateway." - }, - "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Port" - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "cookieBasedAffinity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cookie based affinity." - }, - "requestTimeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probe resource of an application gateway." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Array of references to application gateway authentication certificates." - }, - "connectionDraining": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayConnectionDraining" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connection draining of the backend http settings resource." - }, - "hostName": { - "type": "string", - "description": "Host header to be sent to the backend servers." - }, - "pickHostNameFromBackendAddress": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." - }, - "affinityCookieName": { - "type": "string", - "description": "Cookie name to use for the affinity cookie." - }, - "probeEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the probe is enabled. Default value is false." - }, - "path": { - "type": "string", - "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Backend address pool settings of an application gateway." - }, - "ApplicationGatewayConnectionDraining": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether connection draining is enabled or not." - }, - "drainTimeoutInSec": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 3600 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." - } - }, - "required": [ - "enabled", - "drainTimeoutInSec" - ], - "description": "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." - }, - "ApplicationGatewayFirewallDisabledRuleGroup": { - "type": "object", - "properties": { - "ruleGroupName": { - "type": "string", - "description": "The name of the rule group that will be disabled." - }, - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." - } - }, - "required": [ - "ruleGroupName" - ], - "description": "Allows to disable rules within a rule group or an entire rule group." - }, - "ApplicationGatewayFrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "PrivateIPAddress of the network interface IP Configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PrivateIP allocation method." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the PublicIP resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP configuration of an application gateway." - }, - "ApplicationGatewayFrontendPort": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Frontend port of an application gateway." - }, - "ApplicationGatewayFrontendPortPropertiesFormat": { - "type": "object", - "properties": { - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend port of an application gateway." - }, - "ApplicationGatewayHttpListener": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Http listener of an application gateway." - }, - "ApplicationGatewayHttpListenerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP configuration resource of an application gateway." - }, - "frontendPort": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of an application gateway." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "hostName": { - "type": "string", - "description": "Host name of HTTP listener." - }, - "sslCertificate": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificate resource of an application gateway." - }, - "requireServerNameIndication": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of HTTP listener of an application gateway." - }, - "ApplicationGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." - }, - "ApplicationGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration of an application gateway." - }, - "ApplicationGatewayPathRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Path rule of URL path map of an application gateway." - }, - "ApplicationGatewayPathRulePropertiesFormat": { - "type": "object", - "properties": { - "paths": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules of URL path map." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of URL path map path rule." - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings resource of URL path map path rule." - }, - "redirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configuration resource of URL path map path rule." - }, - "provisioningState": { - "type": "string", - "description": "Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of path rule of an application gateway." - }, - "ApplicationGatewayProbe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Probe of the application gateway." - }, - "ApplicationGatewayProbeHealthResponseMatch": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "Body that must be contained in the health response. Default value is empty." - }, - "statusCodes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." - } - }, - "description": "Application gateway probe health response match" - }, - "ApplicationGatewayProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Https" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol." - }, - "host": { - "type": "string", - "description": "Host name to send the probe to." - }, - "path": { - "type": "string", - "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:" - }, - "interval": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." - }, - "timeout": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." - }, - "pickHostNameFromBackendHttpSettings": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the host header should be picked from the backend http settings. Default value is false." - }, - "minServers": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum number of servers that are always marked healthy. Default value is 0." - }, - "match": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Criterion for classifying a healthy probe response." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of probe of an application gateway." - }, - "ApplicationGatewayPropertiesFormat": { - "type": "object", - "properties": { - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SKU of the application gateway resource." - }, - "sslPolicy": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslPolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL policy of the application gateway resource." - }, - "gatewayIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnets of application the gateway resource." - }, - "authenticationCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Authentication certificates of the application gateway resource." - }, - "sslCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewaySslCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL certificates of the application gateway resource." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend IP addresses of the application gateway resource." - }, - "frontendPorts": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFrontendPort" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend ports of the application gateway resource." - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayProbe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Probes of the application gateway resource." - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool of the application gateway resource." - }, - "backendHttpSettingsCollection": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend http settings of the application gateway resource." - }, - "httpListeners": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayHttpListener" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listeners of the application gateway resource." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayUrlPathMap" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map of the application gateway resource." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing rules of the application gateway resource." - }, - "redirectConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configurations of the application gateway resource." - }, - "webApplicationFirewallConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall configuration." - }, - "enableHttp2": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether HTTP2 is enabled on the application gateway resource." - }, - "resourceGuid": { - "type": "string", - "description": "Resource GUID property of the application gateway resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the application gateway." - }, - "ApplicationGatewayRedirectConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Redirect configuration of an application gateway." - }, - "ApplicationGatewayRedirectConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "redirectType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Permanent", - "Found", - "SeeOther", - "Temporary" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Supported http redirection types - Permanent, Temporary, Found, SeeOther." - }, - "targetListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Reference to a listener to redirect the request to." - }, - "targetUrl": { - "type": "string", - "description": "Url to redirect the request to." - }, - "includePath": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Include path in the redirected url." - }, - "includeQueryString": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Include query string in the redirected url." - }, - "requestRoutingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request routing specifying redirect configuration." - }, - "urlPathMaps": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Url path maps specifying default redirect configuration." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rules specifying redirect configuration." - } - }, - "description": "Properties of redirect configuration of the application gateway." - }, - "ApplicationGatewayRequestRoutingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "Request routing rule of an application gateway." - }, - "ApplicationGatewayRequestRoutingRulePropertiesFormat": { - "type": "object", - "properties": { - "ruleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "PathBasedRouting" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Rule type." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Backend address pool resource of the application gateway. " - }, - "backendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Frontend port resource of the application gateway." - }, - "httpListener": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Http listener resource of the application gateway. " - }, - "urlPathMap": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "URL path map resource of the application gateway." - }, - "redirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Redirect configuration resource of the application gateway." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of request routing rule of the application gateway." - }, - "ApplicationGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_Small", - "Standard_Medium", - "Standard_Large", - "WAF_Medium", - "WAF_Large" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of an application gateway SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "WAF" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Tier of an application gateway." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capacity (instance count) of an application gateway." - } - }, - "description": "SKU of an application gateway" - }, - "ApplicationGatewaySslCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "SSL certificates of an application gateway." - }, - "ApplicationGatewaySslCertificatePropertiesFormat": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." - }, - "password": { - "type": "string", - "description": "Password for the pfx file specified in data. Only applicable in PUT request." - }, - "publicCertData": { - "type": "string", - "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of SSL certificates of an application gateway." - }, - "ApplicationGatewaySslPolicy": { - "type": "object", - "properties": { - "disabledSslProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ssl protocols to be disabled on application gateway." - }, - "policyType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Predefined", - "Custom" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of Ssl Policy." - }, - "policyName": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AppGwSslPolicy20150501", - "AppGwSslPolicy20170401", - "AppGwSslPolicy20170401S" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of Ssl predefined policy." - }, - "cipherSuites": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", - "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", - "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", - "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", - "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", - "TLS_RSA_WITH_AES_256_GCM_SHA384", - "TLS_RSA_WITH_AES_128_GCM_SHA256", - "TLS_RSA_WITH_AES_256_CBC_SHA256", - "TLS_RSA_WITH_AES_128_CBC_SHA256", - "TLS_RSA_WITH_AES_256_CBC_SHA", - "TLS_RSA_WITH_AES_128_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", - "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", - "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", - "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", - "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", - "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", - "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", - "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", - "TLS_RSA_WITH_3DES_EDE_CBC_SHA" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Ssl cipher suites to be enabled in the specified order to application gateway." - }, - "minProtocolVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TLSv1_0", - "TLSv1_1", - "TLSv1_2" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum version of Ssl protocol to be supported on application gateway." - } - }, - "description": "Application Gateway Ssl policy." - }, - "ApplicationGatewayUrlPathMap": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "type": { - "type": "string", - "description": "Type of the resource." - } - }, - "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." - }, - "ApplicationGatewayUrlPathMapPropertiesFormat": { - "type": "object", - "properties": { - "defaultBackendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend address pool resource of URL path map." - }, - "defaultBackendHttpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default backend http settings resource of URL path map." - }, - "defaultRedirectConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default redirect configuration resource of URL path map." - }, - "pathRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayPathRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Path rule of URL path map resource." - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of UrlPathMap of the application gateway." - }, - "ApplicationGatewayWebApplicationFirewallConfiguration": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the web application firewall is enabled or not." - }, - "firewallMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Detection", - "Prevention" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Web application firewall mode." - }, - "ruleSetType": { - "type": "string", - "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." - }, - "ruleSetVersion": { - "type": "string", - "description": "The version of the rule set type." - }, - "disabledRuleGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The disabled rule groups." - } - }, - "required": [ - "enabled", - "firewallMode", - "ruleSetType", - "ruleSetVersion" - ], - "description": "Application gateway web application firewall configuration." - }, - "ApplicationSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the application security group." - } - }, - "description": "An application security group in a resource group." - }, - "ApplicationSecurityGroupPropertiesFormat": { - "type": "object", - "properties": {}, - "description": "Application security group properties." - }, - "AuthorizationPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorization key." - }, - "authorizationUseStatus": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Available", - "InUse" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - } - }, - "BackendAddressPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/BackendAddressPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer backend address pool." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Pool of backend IP addresses." - }, - "BackendAddressPoolPropertiesFormat": { - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "description": "Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the backend address pool." - }, - "BgpSettings": { - "type": "object", - "properties": { - "asn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BGP speaker's ASN." - }, - "bgpPeeringAddress": { - "type": "string", - "description": "The BGP peering address and BGP identifier of this BGP speaker." - }, - "peerWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The weight added to routes learned from this BGP speaker." - } - }, - "description": "BGP settings details" - }, - "ConnectionMonitorDestination": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "description": "The ID of the resource used as the destination by connection monitor." - }, - "address": { - "type": "string", - "description": "Address of the connection monitor destination (IP or domain name)." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The destination port used by connection monitor." - } - }, - "description": "Describes the destination of connection monitor." - }, - "ConnectionMonitorParameters": { - "type": "object", - "properties": { - "source": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectionMonitorSource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "destination": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectionMonitorDestination" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "autoStart": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Determines if the connection monitor will start automatically once created." - }, - "monitoringIntervalInSeconds": { - "oneOf": [ - { - "type": "integer", - "default": "60" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Monitoring interval in seconds." - } - }, - "required": [ - "source", - "destination" - ], - "description": "Parameters that define the operation to create a connection monitor." - }, - "ConnectionMonitorSource": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "description": "The ID of the resource used as the source by connection monitor." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source port used by connection monitor." - } - }, - "required": [ - "resourceId" - ], - "description": "Describes the source of connection monitor." - }, - "DhcpOptions": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of DNS servers IP addresses." - } - }, - "description": "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." - }, - "ExpressRouteCircuitAuthorization": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Authorization in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "Peering in an ExpressRouteCircuit resource." - }, - "ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "advertisedPublicPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of AdvertisedPublicPrefixes." - }, - "advertisedCommunities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The communities of bgp peering. Spepcified for microsoft peering" - }, - "advertisedPublicPrefixesState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotConfigured", - "Configuring", - "Configured", - "ValidationNeeded" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'." - }, - "legacyMode": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The legacy mode of the peering." - }, - "customerASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CustomerASN of the peering." - }, - "routingRegistryName": { - "type": "string", - "description": "The RoutingRegistryName of the configuration." - } - }, - "description": "Specifies the peering configuration." - }, - "ExpressRouteCircuitPeeringPropertiesFormat": { - "type": "object", - "properties": { - "peeringType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzurePublicPeering", - "AzurePrivatePeering", - "MicrosoftPeering" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - }, - "azureASN": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Azure ASN." - }, - "peerASN": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 4294967295 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The peer ASN." - }, - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "primaryAzurePort": { - "type": "string", - "description": "The primary port." - }, - "secondaryAzurePort": { - "type": "string", - "description": "The secondary port." - }, - "sharedKey": { - "type": "string", - "description": "The shared key." - }, - "vlanId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The VLAN ID." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "stats": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitStats" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets peering stats." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets whether the provider or the customer last modified the peering." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "ipv6PeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPv6 peering configuration." - } - } - }, - "ExpressRouteCircuitPropertiesFormat": { - "type": "object", - "properties": { - "allowClassicOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allow classic operations" - }, - "circuitProvisioningState": { - "type": "string", - "description": "The CircuitProvisioningState state of the resource." - }, - "serviceProviderProvisioningState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "NotProvisioned", - "Provisioning", - "Provisioned", - "Deprovisioning" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'." - }, - "authorizations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitAuthorization" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of authorizations." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of peerings." - }, - "serviceKey": { - "type": "string", - "description": "The ServiceKey." - }, - "serviceProviderNotes": { - "type": "string", - "description": "The ServiceProviderNotes." - }, - "serviceProviderProperties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The ServiceProviderProperties." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "gatewayManagerEtag": { - "type": "string", - "description": "The GatewayManager Etag." - } - }, - "description": "Properties of ExpressRouteCircuit." - }, - "ExpressRouteCircuitServiceProviderProperties": { - "type": "object", - "properties": { - "serviceProviderName": { - "type": "string", - "description": "The serviceProviderName." - }, - "peeringLocation": { - "type": "string", - "description": "The peering location." - }, - "bandwidthInMbps": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The BandwidthInMbps." - } - }, - "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SKU." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Premium" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The tier of the SKU. Possible values are 'Standard' and 'Premium'." - }, - "family": { - "oneOf": [ - { - "type": "string", - "enum": [ - "UnlimitedData", - "MeteredData" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'." - } - }, - "description": "Contains SKU in an ExpressRouteCircuit." - }, - "ExpressRouteCircuitStats": { - "type": "object", - "properties": { - "primarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "primarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - }, - "secondarybytesIn": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesIn of the peering." - }, - "secondarybytesOut": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets BytesOut of the peering." - } - }, - "description": "Contains stats associated with the peering." - }, - "expressRouteCircuits_authorizations_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "authorizations" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AuthorizationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/authorizations" - }, - "expressRouteCircuits_peerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "peerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/expressRouteCircuits/peerings" - }, - "FrontendIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the load balancer probe." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "description": "Frontend IP address of the load balancer." - }, - "FrontendIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAddress": { - "type": "string", - "description": "The private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the Public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of Frontend IP Configuration of the load balancer." - }, - "InboundNatPool": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatPoolPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat pool." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT pool of the load balancer." - }, - "InboundNatPoolPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp", - "All" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "frontendPortRangeStart": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "frontendPortRangeEnd": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPortRangeStart", - "frontendPortRangeEnd", - "backendPort" - ], - "description": "Properties of Inbound NAT pool." - }, - "InboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Inbound NAT rule of the load balancer." - }, - "InboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp", - "All" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the inbound NAT rule." - }, - "IpsecPolicy": { - "type": "object", - "properties": { - "saLifeTimeSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." - }, - "saDataSizeKilobytes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." - }, - "ipsecEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DES", - "DES3", - "AES128", - "AES192", - "AES256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec encryption algorithm (IKE phase 1)." - }, - "ipsecIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "GCMAES128", - "GCMAES192", - "GCMAES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec integrity algorithm (IKE phase 1)." - }, - "ikeEncryption": { - "oneOf": [ - { - "type": "string", - "enum": [ - "DES", - "DES3", - "AES128", - "AES192", - "AES256" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE encryption algorithm (IKE phase 2)." - }, - "ikeIntegrity": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MD5", - "SHA1", - "SHA256", - "SHA384" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IKE integrity algorithm (IKE phase 2)." - }, - "dhGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "DHGroup1", - "DHGroup2", - "DHGroup14", - "DHGroup2048", - "ECP256", - "ECP384", - "DHGroup24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 1 for initial SA." - }, - "pfsGroup": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "PFS1", - "PFS2", - "PFS2048", - "ECP256", - "ECP384", - "PFS24" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DH Groups used in IKE Phase 2 for new child SA." - } - }, - "required": [ - "saLifeTimeSeconds", - "saDataSizeKilobytes", - "ipsecEncryption", - "ipsecIntegrity", - "ikeEncryption", - "ikeIntegrity", - "dhGroup", - "pfsGroup" - ], - "description": "An IPSec Policy configuration for a virtual network gateway connection" - }, - "Ipv6ExpressRouteCircuitPeeringConfig": { - "type": "object", - "properties": { - "primaryPeerAddressPrefix": { - "type": "string", - "description": "The primary address prefix." - }, - "secondaryPeerAddressPrefix": { - "type": "string", - "description": "The secondary address prefix." - }, - "microsoftPeeringConfig": { - "oneOf": [ - { - "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Microsoft peering configuration." - }, - "routeFilter": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilter" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteFilter resource." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'." - } - }, - "description": "Contains IPv6 peering config." - }, - "LoadBalancerPropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/FrontendIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object representing the frontend IPs to be used for the load balancer" - }, - "backendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of backend address pools used by a load balancer" - }, - "loadBalancingRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/LoadBalancingRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Object collection representing the load balancing rules Gets the provisioning " - }, - "probes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Probe" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of probe objects used in the load balancer" - }, - "inboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "inboundNatPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "outboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/OutboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The outbound NAT rules." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the load balancer resource." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of the load balancer." - }, - "LoadBalancerSku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of a load balancer SKU." - } - }, - "description": "SKU of a load balancer" - }, - "loadBalancers_inboundNatRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "inboundNatRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/InboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer inbound nat rule." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/loadBalancers/inboundNatRules" - }, - "LoadBalancingRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LoadBalancingRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer load balancing rule." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancing rule for a load balancer." - }, - "LoadBalancingRulePropertiesFormat": { - "type": "object", - "properties": { - "frontendIPConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to frontend IP addresses." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "probe": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the load balancer probe used by the load balancing rule." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Udp", - "Tcp", - "All" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "loadDistribution": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Default", - "SourceIP", - "SourceIPProtocol" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'." - }, - "frontendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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\"" - }, - "backendPort": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables \"Any Port\"" - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." - }, - "enableFloatingIP": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." - }, - "disableOutboundSnat": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "frontendPort" - ], - "description": "Properties of the load balancer." - }, - "LocalNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the local network gateway." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "LocalNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "localNetworkAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network site address space." - }, - "gatewayIpAddress": { - "type": "string", - "description": "IP address of local network gateway." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Local network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the LocalNetworkGateway resource." - } - }, - "description": "LocalNetworkGateway properties" - }, - "NetworkInterfaceDnsSettings": { - "type": "object", - "properties": { - "dnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "appliedDnsServers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "internalDnsNameLabel": { - "type": "string", - "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." - }, - "internalFqdn": { - "type": "string", - "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." - }, - "internalDomainNameSuffix": { - "type": "string", - "description": "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." - } - }, - "description": "DNS settings of a network interface." - }, - "NetworkInterfaceIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network interface IP configuration properties." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IPConfiguration in a network interface." - }, - "NetworkInterfaceIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of ApplicationGatewayBackendAddressPool resource." - }, - "loadBalancerBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/BackendAddressPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of LoadBalancerBackendAddressPool resource." - }, - "loadBalancerInboundNatRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/InboundNatRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of references of LoadBalancerInboundNatRules." - }, - "privateIPAddress": { - "type": "string", - "description": "Private IP address of the IP configuration." - }, - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'." - }, - "privateIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/Subnet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Subnet bound to the IP configuration." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary customer address on the network interface." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddress" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address bound to the IP configuration." - }, - "applicationSecurityGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationSecurityGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Application security groups in which the IP configuration is included." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Properties of IP configuration." - }, - "NetworkInterfacePropertiesFormat": { - "type": "object", - "properties": { - "virtualMachine": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of a virtual machine." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of IPConfigurations of the network interface." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The DNS settings in network interface." - }, - "macAddress": { - "type": "string", - "description": "The MAC address of the network interface." - }, - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets whether this is a primary network interface on a virtual machine." - }, - "enableAcceleratedNetworking": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If the network interface is accelerated networking enabled." - }, - "enableIPForwarding": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether IP forwarding is enabled on this network interface." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network interface resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "NetworkInterface properties. " - }, - "NetworkSecurityGroup": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the network security group" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "NetworkSecurityGroup resource." - }, - "NetworkSecurityGroupPropertiesFormat": { - "type": "object", - "properties": { - "securityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of security rules of the network security group." - }, - "defaultSecurityRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The default security rules of network security group." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the network security group resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Network Security Group resource." - }, - "networkSecurityGroups_securityRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "securityRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkSecurityGroups/securityRules" - }, - "NetworkWatcherPropertiesFormat": { - "type": "object", - "properties": {}, - "description": "The network watcher properties." - }, - "networkWatchers_connectionMonitors_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "connectionMonitors" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "location": { - "type": "string", - "description": "Connection monitor location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connection monitor tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ConnectionMonitorParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/connectionMonitors" - }, - "networkWatchers_packetCaptures_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "packetCaptures" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/networkWatchers/packetCaptures" - }, - "OutboundNatRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/OutboundNatRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer outbound nat rule." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Outbound NAT pool of the load balancer." - }, - "OutboundNatRulePropertiesFormat": { - "type": "object", - "properties": { - "allocatedOutboundPorts": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The number of outbound ports to be used for NAT." - }, - "frontendIPConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Frontend IP addresses of the load balancer." - }, - "backendAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "backendAddressPool" - ], - "description": "Outbound NAT pool of the load balancer." - }, - "PacketCaptureFilter": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "TCP", - "UDP", - "Any" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Protocol to be filtered on." - }, - "localIPAddress": { - "type": "string", - "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." - }, - "remoteIPAddress": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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." - }, - "remotePort": { - "type": "string", - "description": "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." - } - }, - "description": "Filter that is applied to packet capture request. Multiple filters can be applied." - }, - "PacketCaptureParameters": { - "type": "object", - "properties": { - "target": { - "type": "string", - "description": "The ID of the targeted resource, only VM is currently supported." - }, - "bytesToCapturePerPacket": { - "oneOf": [ - { - "type": "integer", - "default": "0" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of bytes captured per packet, the remaining bytes are truncated." - }, - "totalBytesPerSession": { - "oneOf": [ - { - "type": "integer", - "default": "1073741824" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum size of the capture output." - }, - "timeLimitInSeconds": { - "oneOf": [ - { - "type": "integer", - "default": "18000" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum duration of the capture session in seconds." - }, - "storageLocation": { - "oneOf": [ - { - "$ref": "#/definitions/PacketCaptureStorageLocation" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "filters": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/PacketCaptureFilter" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "target", - "storageLocation" - ], - "description": "Parameters that define the create packet capture operation." - }, - "PacketCaptureStorageLocation": { - "type": "object", - "properties": { - "storageId": { - "type": "string", - "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." - }, - "storagePath": { - "type": "string", - "description": "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." - }, - "filePath": { - "type": "string", - "description": "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." - } - }, - "description": "Describes the storage location for a packet capture session." - }, - "Probe": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ProbePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of load balancer probe." - }, - "name": { - "type": "string", - "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "A load balancer probe." - }, - "ProbePropertiesFormat": { - "type": "object", - "properties": { - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Http", - "Tcp" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." - }, - "intervalInSeconds": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "numberOfProbes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "requestPath": { - "type": "string", - "description": "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." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "port" - ], - "description": "Load balancer probe resource." - }, - "PublicIPAddress": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressSku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address SKU." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public IP address properties." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "zones": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." - } - }, - "description": "Public IP address resource." - }, - "PublicIPAddressDnsSettings": { - "type": "object", - "properties": { - "domainNameLabel": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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": { - "type": "string", - "description": "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. " - } - }, - "description": "Contains FQDN of the DNS record associated with the public IP address" - }, - "PublicIPAddressPropertiesFormat": { - "type": "object", - "properties": { - "publicIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "publicIPAddressVersion": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'." - }, - "dnsSettings": { - "oneOf": [ - { - "$ref": "#/definitions/PublicIPAddressDnsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The FQDN of the DNS record associated with the public IP address." - }, - "ipAddress": { - "type": "string", - "description": "The IP address associated with the public IP address resource." - }, - "idleTimeoutInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The idle timeout of the public IP address." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the public IP resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Public IP address properties." - }, - "PublicIPAddressSku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "Standard" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Name of a public IP address SKU." - } - }, - "description": "SKU of a public IP address" - }, - "ResourceNavigationLink": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ResourceNavigationLinkFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource navigation link properties format." - }, - "name": { - "type": "string", - "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." - } - }, - "description": "ResourceNavigationLink resource." - }, - "ResourceNavigationLinkFormat": { - "type": "object", - "properties": { - "linkedResourceType": { - "type": "string", - "description": "Resource type of the linked resource." - }, - "link": { - "type": "string", - "description": "Link to the external resource" - } - }, - "description": "Properties of ResourceNavigationLink." - }, - "Route": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route resource" - }, - "RouteFilter": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Route Filter Resource." - }, - "RouteFilterPropertiesFormat": { - "type": "object", - "properties": { - "rules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RouteFilterRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of RouteFilterRules contained within a route filter." - }, - "peerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ExpressRouteCircuitPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A collection of references to express route circuit peerings." - } - }, - "description": "Route Filter Resource" - }, - "RouteFilterRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "description": "Route Filter Rule Resource" - }, - "RouteFilterRulePropertiesFormat": { - "type": "object", - "properties": { - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The access type of the rule. Valid values are: 'Allow', 'Deny'." - }, - "routeFilterRuleType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Community" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The rule type of the rule. Valid value is: 'Community'" - }, - "communities": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']" - } - }, - "required": [ - "access", - "routeFilterRuleType", - "communities" - ], - "description": "Route Filter Rule Resource" - }, - "routeFilters_routeFilterRules_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routeFilterRules" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteFilterRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeFilters/routeFilterRules" - }, - "RoutePropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The destination CIDR to which the route applies." - }, - "nextHopType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "VirtualNetworkGateway", - "VnetLocal", - "Internet", - "VirtualAppliance", - "None" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'." - }, - "nextHopIpAddress": { - "type": "string", - "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "nextHopType" - ], - "description": "Route resource" - }, - "RouteTable": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTablePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route table." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Route table resource." - }, - "RouteTablePropertiesFormat": { - "type": "object", - "properties": { - "routes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Route" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Collection of routes contained within a route table." - }, - "disableBgpRoutePropagation": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets whether to disable the routes learned by BGP on that route table. True means disable." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "description": "Route Table resource" - }, - "routeTables_routes_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RoutePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the route." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/routeTables/routes" - }, - "SecurityRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SecurityRulePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the security rule" - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Network security rule." - }, - "SecurityRulePropertiesFormat": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description for this rule. Restricted to 140 chars." - }, - "protocol": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Tcp", - "Udp", - "*" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'." - }, - "sourcePortRange": { - "type": "string", - "description": "The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "destinationPortRange": { - "type": "string", - "description": "The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." - }, - "sourceAddressPrefix": { - "type": "string", - "description": "The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " - }, - "sourceAddressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The CIDR or source IP ranges." - }, - "sourceApplicationSecurityGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationSecurityGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The application security group specified as source." - }, - "destinationAddressPrefix": { - "type": "string", - "description": "The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." - }, - "destinationAddressPrefixes": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The destination address prefixes. CIDR or destination IP ranges." - }, - "destinationApplicationSecurityGroups": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationSecurityGroup" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The application security group specified as destination." - }, - "sourcePortRanges": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The source port ranges." - }, - "destinationPortRanges": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The destination port ranges." - }, - "access": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'." - }, - "priority": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "direction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } - }, - "required": [ - "protocol", - "access", - "direction" - ], - "description": "Security rule resource." - }, - "ServiceEndpointPropertiesFormat": { - "type": "object", - "properties": { - "service": { - "type": "string", - "description": "The type of the endpoint service." - }, - "locations": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of locations." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "The service endpoint properties." - }, - "Subnet": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Subnet in a virtual network resource." - }, - "SubnetPropertiesFormat": { - "type": "object", - "properties": { - "addressPrefix": { - "type": "string", - "description": "The address prefix for the subnet." - }, - "networkSecurityGroup": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkSecurityGroup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the NetworkSecurityGroup resource." - }, - "routeTable": { - "oneOf": [ - { - "$ref": "#/definitions/RouteTable" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the RouteTable resource." - }, - "serviceEndpoints": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceEndpointPropertiesFormat" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "An array of service endpoints." - }, - "resourceNavigationLinks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceNavigationLink" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets an array of references to the external resources using subnet." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "Properties of the subnet." - }, - "SubResource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - } - }, - "description": "Reference to another subresource." - }, - "VirtualNetworkGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway." - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "A common class for general resource information" - }, - "VirtualNetworkGatewayConnectionPropertiesFormat": { - "type": "object", - "properties": { - "authorizationKey": { - "type": "string", - "description": "The authorizationKey." - }, - "virtualNetworkGateway1": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to virtual network gateway resource." - }, - "virtualNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to virtual network gateway resource." - }, - "localNetworkGateway2": { - "oneOf": [ - { - "$ref": "#/definitions/LocalNetworkGateway" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to local network gateway resource." - }, - "connectionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "IPsec", - "Vnet2Vnet", - "ExpressRoute", - "VPNClient" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient." - }, - "routingWeight": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The routing weight." - }, - "sharedKey": { - "type": "string", - "description": "The IPSec shared key." - }, - "peer": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference to peerings resource." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "EnableBgp flag" - }, - "usePolicyBasedTrafficSelectors": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Enable policy-based traffic selectors." - }, - "ipsecPolicies": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IpsecPolicy" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The IPSec Policies to be considered by this connection." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." - } - }, - "required": [ - "virtualNetworkGateway1", - "connectionType" - ], - "description": "VirtualNetworkGatewayConnection properties" - }, - "VirtualNetworkGatewayIPConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network gateway ip configuration." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "IP configuration for virtual network gateway" - }, - "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { - "type": "object", - "properties": { - "privateIPAllocationMethod": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Static", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'." - }, - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the subnet resource." - }, - "publicIPAddress": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the public IP resource." - } - }, - "description": "Properties of VirtualNetworkGatewayIPConfiguration" - }, - "VirtualNetworkGatewayPropertiesFormat": { - "type": "object", - "properties": { - "ipConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IP configurations for virtual network gateway." - }, - "gatewayType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Vpn", - "ExpressRoute" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'." - }, - "vpnType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PolicyBased", - "RouteBased" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'." - }, - "enableBgp": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether BGP is enabled for this virtual network gateway or not." - }, - "activeActive": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "ActiveActive flag" - }, - "gatewayDefaultSite": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkGatewaySku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." - }, - "vpnClientConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." - }, - "bgpSettings": { - "oneOf": [ - { - "$ref": "#/definitions/BgpSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual network gateway's BGP speaker settings." - }, - "resourceGuid": { - "type": "string", - "description": "The resource GUID property of the VirtualNetworkGateway resource." - } - }, - "description": "VirtualNetworkGateway properties" - }, - "VirtualNetworkGatewaySku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU name." - }, - "tier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Basic", - "HighPerformance", - "Standard", - "UltraPerformance", - "VpnGw1", - "VpnGw2", - "VpnGw3" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gateway SKU tier." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity." - } - }, - "description": "VirtualNetworkGatewaySku details" - }, - "VirtualNetworkPeering": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "Peerings in a virtual network resource." - }, - "VirtualNetworkPeeringPropertiesFormat": { - "type": "object", - "properties": { - "allowVirtualNetworkAccess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space." - }, - "allowForwardedTraffic": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed." - }, - "allowGatewayTransit": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If gateway links can be used in remote virtual networking to link to this virtual network." - }, - "useRemoteGateways": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "remoteVirtualNetwork": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)." - }, - "remoteAddressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the remote virtual network address space." - }, - "peeringState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Initiated", - "Connected", - "Disconnected" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the resource." - } - }, - "description": "Properties of the virtual network peering." - }, - "VirtualNetworkPropertiesFormat": { - "type": "object", - "properties": { - "addressSpace": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." - }, - "dhcpOptions": { - "oneOf": [ - { - "$ref": "#/definitions/DhcpOptions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." - }, - "subnets": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Subnet" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of subnets in a Virtual Network." - }, - "virtualNetworkPeerings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A list of peerings in a Virtual Network." - }, - "resourceGuid": { - "type": "string", - "description": "The resourceGuid property of the Virtual Network resource." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - }, - "enableDdosProtection": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network." - }, - "enableVmProtection": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates if Vm protection is enabled for all the subnets in a Virtual Network." - } - }, - "description": "Properties of the virtual network." - }, - "virtualNetworks_subnets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "subnets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SubnetPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the subnet." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/subnets" - }, - "virtualNetworks_virtualNetworkPeerings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkPeerings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the virtual network peering." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings" - }, - "VpnClientConfiguration": { - "type": "object", - "properties": { - "vpnClientAddressPool": { - "oneOf": [ - { - "$ref": "#/definitions/AddressSpace" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The reference of the address space resource which represents Address space for P2S VpnClient." - }, - "vpnClientRootCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRootCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRootCertificate for virtual network gateway." - }, - "vpnClientRevokedCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VpnClientRevokedCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientRevokedCertificate for Virtual network gateway." - }, - "vpnClientProtocols": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "IkeV2", - "SSTP" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VpnClientProtocols for Virtual network gateway." - }, - "radiusServerAddress": { - "type": "string", - "description": "The radius server address property of the VirtualNetworkGateway resource for vpn client connection." - }, - "radiusServerSecret": { - "type": "string", - "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection." - } - }, - "description": "VpnClientConfiguration for P2S client." - }, - "VpnClientRevokedCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the vpn client revoked certificate." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "description": "VPN client revoked certificate of virtual network gateway." - }, - "VpnClientRevokedCertificatePropertiesFormat": { - "type": "object", - "properties": { - "thumbprint": { - "type": "string", - "description": "The revoked VPN client certificate thumbprint." - } - }, - "description": "Properties of the revoked VPN client certificate of virtual network gateway." - }, - "VpnClientRootCertificate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties of the vpn client root certificate." - }, - "name": { - "type": "string", - "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." - }, - "etag": { - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "required": [ - "properties" - ], - "description": "VPN client root certificate of virtual network gateway" - }, - "VpnClientRootCertificatePropertiesFormat": { - "type": "object", - "properties": { - "publicCertData": { - "type": "string", - "description": "The certificate public data." - } - }, - "required": [ - "publicCertData" - ], - "description": "Properties of SSL certificates of application gateway" - } - } -} diff --git a/test/Resource/Expected/Network/2017-10-01/applicationGateways.md b/test/Resource/Expected/Network/2017-10-01/applicationGateways.md deleted file mode 100644 index ebc00b0..0000000 --- a/test/Resource/Expected/Network/2017-10-01/applicationGateways.md +++ /dev/null @@ -1,1220 +0,0 @@ -# Microsoft.Network/applicationGateways template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/applicationGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationGateways", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "sslPolicy": { - "disabledSslProtocols": [ - "string" - ], - "policyType": "string", - "policyName": "string", - "cipherSuites": [ - "string" - ], - "minProtocolVersion": "string" - }, - "gatewayIPConfigurations": [ - { - "id": "string", - "properties": { - "subnet": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "authenticationCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "sslCertificates": [ - { - "id": "string", - "properties": { - "data": "string", - "password": "string", - "publicCertData": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "frontendPorts": [ - { - "id": "string", - "properties": { - "port": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "host": "string", - "path": "string", - "interval": "integer", - "timeout": "integer", - "unhealthyThreshold": "integer", - "pickHostNameFromBackendHttpSettings": "boolean", - "minServers": "integer", - "match": { - "body": "string", - "statusCodes": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - "ApplicationGatewayBackendAddressPool" - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "disableBgpRoutePropagation": "boolean", - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "applicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "backendHttpSettingsCollection": [ - { - "id": "string", - "properties": { - "port": "integer", - "protocol": "string", - "cookieBasedAffinity": "string", - "requestTimeout": "integer", - "probe": { - "id": "string" - }, - "authenticationCertificates": [ - { - "id": "string" - } - ], - "connectionDraining": { - "enabled": "boolean", - "drainTimeoutInSec": "integer" - }, - "hostName": "string", - "pickHostNameFromBackendAddress": "boolean", - "affinityCookieName": "string", - "probeEnabled": "boolean", - "path": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "httpListeners": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "frontendPort": { - "id": "string" - }, - "protocol": "string", - "hostName": "string", - "sslCertificate": { - "id": "string" - }, - "requireServerNameIndication": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "urlPathMaps": [ - { - "id": "string", - "properties": { - "defaultBackendAddressPool": { - "id": "string" - }, - "defaultBackendHttpSettings": { - "id": "string" - }, - "defaultRedirectConfiguration": { - "id": "string" - }, - "pathRules": [ - { - "id": "string", - "properties": { - "paths": [ - "string" - ], - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "redirectConfiguration": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "requestRoutingRules": [ - { - "id": "string", - "properties": { - "ruleType": "string", - "backendAddressPool": { - "id": "string" - }, - "backendHttpSettings": { - "id": "string" - }, - "httpListener": { - "id": "string" - }, - "urlPathMap": { - "id": "string" - }, - "redirectConfiguration": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "redirectConfigurations": [ - { - "id": "string", - "properties": { - "redirectType": "string", - "targetListener": { - "id": "string" - }, - "targetUrl": "string", - "includePath": "boolean", - "includeQueryString": "boolean", - "requestRoutingRules": [ - { - "id": "string" - } - ], - "urlPathMaps": [ - { - "id": "string" - } - ], - "pathRules": [ - { - "id": "string" - } - ] - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "webApplicationFirewallConfiguration": { - "enabled": "boolean", - "firewallMode": "string", - "ruleSetType": "string", - "ruleSetVersion": "string", - "disabledRuleGroups": [ - { - "ruleGroupName": "string", - "rules": [ - "integer" - ] - } - ] - }, - "enableHttp2": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationGateways | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [ApplicationGatewayPropertiesFormat object](#ApplicationGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | object | No | SKU of the application gateway resource. - [ApplicationGatewaySku object](#ApplicationGatewaySku) | -| sslPolicy | object | No | SSL policy of the application gateway resource. - [ApplicationGatewaySslPolicy object](#ApplicationGatewaySslPolicy) | -| gatewayIPConfigurations | array | No | Subnets of application the gateway resource. - [ApplicationGatewayIPConfiguration object](#ApplicationGatewayIPConfiguration) | -| authenticationCertificates | array | No | Authentication certificates of the application gateway resource. - [ApplicationGatewayAuthenticationCertificate object](#ApplicationGatewayAuthenticationCertificate) | -| sslCertificates | array | No | SSL certificates of the application gateway resource. - [ApplicationGatewaySslCertificate object](#ApplicationGatewaySslCertificate) | -| frontendIPConfigurations | array | No | Frontend IP addresses of the application gateway resource. - [ApplicationGatewayFrontendIPConfiguration object](#ApplicationGatewayFrontendIPConfiguration) | -| frontendPorts | array | No | Frontend ports of the application gateway resource. - [ApplicationGatewayFrontendPort object](#ApplicationGatewayFrontendPort) | -| probes | array | No | Probes of the application gateway resource. - [ApplicationGatewayProbe object](#ApplicationGatewayProbe) | -| backendAddressPools | array | No | Backend address pool of the application gateway resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| backendHttpSettingsCollection | array | No | Backend http settings of the application gateway resource. - [ApplicationGatewayBackendHttpSettings object](#ApplicationGatewayBackendHttpSettings) | -| httpListeners | array | No | Http listeners of the application gateway resource. - [ApplicationGatewayHttpListener object](#ApplicationGatewayHttpListener) | -| urlPathMaps | array | No | URL path map of the application gateway resource. - [ApplicationGatewayUrlPathMap object](#ApplicationGatewayUrlPathMap) | -| requestRoutingRules | array | No | Request routing rules of the application gateway resource. - [ApplicationGatewayRequestRoutingRule object](#ApplicationGatewayRequestRoutingRule) | -| redirectConfigurations | array | No | Redirect configurations of the application gateway resource. - [ApplicationGatewayRedirectConfiguration object](#ApplicationGatewayRedirectConfiguration) | -| webApplicationFirewallConfiguration | object | No | Web application firewall configuration. - [ApplicationGatewayWebApplicationFirewallConfiguration object](#ApplicationGatewayWebApplicationFirewallConfiguration) | -| enableHttp2 | boolean | No | Whether HTTP2 is enabled on the application gateway resource. | -| resourceGuid | string | No | Resource GUID property of the application gateway resource. | -| provisioningState | string | No | Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of an application gateway SKU. - Standard_Small, Standard_Medium, Standard_Large, WAF_Medium, WAF_Large | -| tier | enum | No | Tier of an application gateway. - Standard or WAF | -| capacity | integer | No | Capacity (instance count) of an application gateway. | - - - -### ApplicationGatewaySslPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| disabledSslProtocols | array | No | Ssl protocols to be disabled on application gateway. - TLSv1_0, TLSv1_1, TLSv1_2 | -| policyType | enum | No | Type of Ssl Policy. - Predefined or Custom | -| policyName | enum | No | Name of Ssl predefined policy. - AppGwSslPolicy20150501, AppGwSslPolicy20170401, AppGwSslPolicy20170401S | -| cipherSuites | array | No | Ssl cipher suites to be enabled in the specified order to application gateway. - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA | -| minProtocolVersion | enum | No | Minimum version of Ssl protocol to be supported on application gateway. - TLSv1_0, TLSv1_1, TLSv1_2 | - - - -### ApplicationGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayIPConfigurationPropertiesFormat object](#ApplicationGatewayIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayAuthenticationCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayAuthenticationCertificatePropertiesFormat object](#ApplicationGatewayAuthenticationCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewaySslCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewaySslCertificatePropertiesFormat object](#ApplicationGatewaySslCertificatePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayFrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendIPConfigurationPropertiesFormat object](#ApplicationGatewayFrontendIPConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayFrontendPort object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayFrontendPortPropertiesFormat object](#ApplicationGatewayFrontendPortPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayProbe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayProbePropertiesFormat object](#ApplicationGatewayProbePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayBackendHttpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendHttpSettingsPropertiesFormat object](#ApplicationGatewayBackendHttpSettingsPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayHttpListener object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayHttpListenerPropertiesFormat object](#ApplicationGatewayHttpListenerPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayUrlPathMap object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayUrlPathMapPropertiesFormat object](#ApplicationGatewayUrlPathMapPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayRequestRoutingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRequestRoutingRulePropertiesFormat object](#ApplicationGatewayRequestRoutingRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayRedirectConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayRedirectConfigurationPropertiesFormat object](#ApplicationGatewayRedirectConfigurationPropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### ApplicationGatewayWebApplicationFirewallConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether the web application firewall is enabled or not. | -| firewallMode | enum | Yes | Web application firewall mode. - Detection or Prevention | -| ruleSetType | string | Yes | The type of the web application firewall rule set. Possible values are: 'OWASP'. | -| ruleSetVersion | string | Yes | The version of the rule set type. | -| disabledRuleGroups | array | No | The disabled rule groups. - [ApplicationGatewayFirewallDisabledRuleGroup object](#ApplicationGatewayFirewallDisabledRuleGroup) | - - - -### ApplicationGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| subnet | object | No | Reference of the subnet resource. A subnet from where application gateway gets its private address. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayAuthenticationCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Certificate public data. | -| provisioningState | string | No | Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewaySslCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| data | string | No | Base-64 encoded pfx certificate. Only applicable in PUT Request. | -| password | string | No | Password for the pfx file specified in data. Only applicable in PUT request. | -| publicCertData | string | No | Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. | -| provisioningState | string | No | Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | PrivateIPAddress of the network interface IP Configuration. | -| privateIPAllocationMethod | enum | No | PrivateIP allocation method. - Static or Dynamic | -| subnet | object | No | Reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | Reference of the PublicIP resource. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayFrontendPortPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Frontend port | -| provisioningState | string | No | Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol. - Http or Https | -| host | string | No | Host name to send the probe to. | -| path | string | No | Relative path of probe. Valid path starts from '/'. Probe is sent to ://: | -| interval | integer | No | The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. | -| timeout | integer | No | 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 | integer | No | The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. | -| pickHostNameFromBackendHttpSettings | boolean | No | Whether the host header should be picked from the backend http settings. Default value is false. | -| minServers | integer | No | Minimum number of servers that are always marked healthy. Default value is 0. | -| match | object | No | Criterion for classifying a healthy probe response. - [ApplicationGatewayProbeHealthResponseMatch object](#ApplicationGatewayProbeHealthResponseMatch) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendHttpSettingsPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| port | integer | No | Port | -| protocol | enum | No | Protocol. - Http or Https | -| cookieBasedAffinity | enum | No | Cookie based affinity. - Enabled or Disabled | -| requestTimeout | integer | No | 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. | -| probe | object | No | Probe resource of an application gateway. - [SubResource object](#SubResource) | -| authenticationCertificates | array | No | Array of references to application gateway authentication certificates. - [SubResource object](#SubResource) | -| connectionDraining | object | No | Connection draining of the backend http settings resource. - [ApplicationGatewayConnectionDraining object](#ApplicationGatewayConnectionDraining) | -| hostName | string | No | Host header to be sent to the backend servers. | -| pickHostNameFromBackendAddress | boolean | No | Whether to pick host header should be picked from the host name of the backend server. Default value is false. | -| affinityCookieName | string | No | Cookie name to use for the affinity cookie. | -| probeEnabled | boolean | No | Whether the probe is enabled. Default value is false. | -| path | string | No | Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayHttpListenerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | Frontend IP configuration resource of an application gateway. - [SubResource object](#SubResource) | -| frontendPort | object | No | Frontend port resource of an application gateway. - [SubResource object](#SubResource) | -| protocol | enum | No | Protocol. - Http or Https | -| hostName | string | No | Host name of HTTP listener. | -| sslCertificate | object | No | SSL certificate resource of an application gateway. - [SubResource object](#SubResource) | -| requireServerNameIndication | boolean | No | Applicable only if protocol is https. Enables SNI for multi-hosting. | -| provisioningState | string | No | Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayUrlPathMapPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultBackendAddressPool | object | No | Default backend address pool resource of URL path map. - [SubResource object](#SubResource) | -| defaultBackendHttpSettings | object | No | Default backend http settings resource of URL path map. - [SubResource object](#SubResource) | -| defaultRedirectConfiguration | object | No | Default redirect configuration resource of URL path map. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rule of URL path map resource. - [ApplicationGatewayPathRule object](#ApplicationGatewayPathRule) | -| provisioningState | string | No | Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRequestRoutingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleType | enum | No | Rule type. - Basic or PathBasedRouting | -| backendAddressPool | object | No | Backend address pool resource of the application gateway. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Frontend port resource of the application gateway. - [SubResource object](#SubResource) | -| httpListener | object | No | Http listener resource of the application gateway. - [SubResource object](#SubResource) | -| urlPathMap | object | No | URL path map resource of the application gateway. - [SubResource object](#SubResource) | -| redirectConfiguration | object | No | Redirect configuration resource of the application gateway. - [SubResource object](#SubResource) | -| provisioningState | string | No | Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayRedirectConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| redirectType | enum | No | Supported http redirection types - Permanent, Temporary, Found, SeeOther. - Permanent, Found, SeeOther, Temporary | -| targetListener | object | No | Reference to a listener to redirect the request to. - [SubResource object](#SubResource) | -| targetUrl | string | No | Url to redirect the request to. | -| includePath | boolean | No | Include path in the redirected url. | -| includeQueryString | boolean | No | Include query string in the redirected url. | -| requestRoutingRules | array | No | Request routing specifying redirect configuration. - [SubResource object](#SubResource) | -| urlPathMaps | array | No | Url path maps specifying default redirect configuration. - [SubResource object](#SubResource) | -| pathRules | array | No | Path rules specifying redirect configuration. - [SubResource object](#SubResource) | - - - -### ApplicationGatewayFirewallDisabledRuleGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ruleGroupName | string | Yes | The name of the rule group that will be disabled. | -| rules | array | No | The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - integer | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### ApplicationGatewayProbeHealthResponseMatch object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| body | string | No | Body that must be contained in the health response. Default value is empty. | -| statusCodes | array | No | Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - string | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Network interface IP configuration properties. - [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### ApplicationGatewayConnectionDraining object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | Yes | Whether connection draining is enabled or not. | -| drainTimeoutInSec | integer | Yes | The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. | - - - -### ApplicationGatewayPathRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayPathRulePropertiesFormat object](#ApplicationGatewayPathRulePropertiesFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | Private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | Subnet bound to the IP configuration. - [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | Public IP address bound to the IP configuration. - [PublicIPAddress object](#PublicIPAddress) | -| applicationSecurityGroups | array | No | Application security groups in which the IP configuration is included. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| provisioningState | string | No | The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayPathRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| paths | array | No | Path rules of URL path map. - string | -| backendAddressPool | object | No | Backend address pool resource of URL path map path rule. - [SubResource object](#SubResource) | -| backendHttpSettings | object | No | Backend http settings resource of URL path map path rule. - [SubResource object](#SubResource) | -| redirectConfiguration | object | No | Redirect configuration resource of URL path map path rule. - [SubResource object](#SubResource) | -| provisioningState | string | No | Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | Udp, Tcp, All | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| disableBgpRoutePropagation | boolean | No | Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-10-01/applicationSecurityGroups.md b/test/Resource/Expected/Network/2017-10-01/applicationSecurityGroups.md deleted file mode 100644 index a491755..0000000 --- a/test/Resource/Expected/Network/2017-10-01/applicationSecurityGroups.md +++ /dev/null @@ -1,33 +0,0 @@ -# Microsoft.Network/applicationSecurityGroups template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/applicationSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/applicationSecurityGroups", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/applicationSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/applicationSecurityGroups | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-10-01/connections.md b/test/Resource/Expected/Network/2017-10-01/connections.md deleted file mode 100644 index 8dd3834..0000000 --- a/test/Resource/Expected/Network/2017-10-01/connections.md +++ /dev/null @@ -1,403 +0,0 @@ -# Microsoft.Network/connections template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/connections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/connections", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "authorizationKey": "string", - "virtualNetworkGateway1": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "virtualNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "localNetworkGateway2": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" - }, - "connectionType": "string", - "routingWeight": "integer", - "sharedKey": "string", - "peer": { - "id": "string" - }, - "enableBgp": "boolean", - "usePolicyBasedTrafficSelectors": "boolean", - "ipsecPolicies": [ - { - "saLifeTimeSeconds": "integer", - "saDataSizeKilobytes": "integer", - "ipsecEncryption": "string", - "ipsecIntegrity": "string", - "ikeEncryption": "string", - "ikeIntegrity": "string", - "dhGroup": "string", - "pfsGroup": "string" - } - ], - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/connections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/connections | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway connection. - [VirtualNetworkGatewayConnectionPropertiesFormat object](#VirtualNetworkGatewayConnectionPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayConnectionPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorizationKey. | -| virtualNetworkGateway1 | object | Yes | The reference to virtual network gateway resource. - [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| virtualNetworkGateway2 | object | No | The reference to virtual network gateway resource. - [VirtualNetworkGateway object](#VirtualNetworkGateway) | -| localNetworkGateway2 | object | No | The reference to local network gateway resource. - [LocalNetworkGateway object](#LocalNetworkGateway) | -| connectionType | enum | Yes | Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. - IPsec, Vnet2Vnet, ExpressRoute, VPNClient | -| routingWeight | integer | No | The routing weight. | -| sharedKey | string | No | The IPSec shared key. | -| peer | object | No | The reference to peerings resource. - [SubResource object](#SubResource) | -| enableBgp | boolean | No | EnableBgp flag | -| usePolicyBasedTrafficSelectors | boolean | No | Enable policy-based traffic selectors. | -| ipsecPolicies | array | No | The IPSec Policies to be considered by this connection. - [IpsecPolicy object](#IpsecPolicy) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGatewayConnection resource. | - - - -### VirtualNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway. - [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGateway object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the local network gateway. - [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### IpsecPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| saLifeTimeSeconds | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. | -| saDataSizeKilobytes | integer | Yes | The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. | -| ipsecEncryption | enum | Yes | The IPSec encryption algorithm (IKE phase 1). - None, DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256 | -| ipsecIntegrity | enum | Yes | The IPSec integrity algorithm (IKE phase 1). - MD5, SHA1, SHA256, GCMAES128, GCMAES192, GCMAES256 | -| ikeEncryption | enum | Yes | The IKE encryption algorithm (IKE phase 2). - DES, DES3, AES128, AES192, AES256 | -| ikeIntegrity | enum | Yes | The IKE integrity algorithm (IKE phase 2). - MD5, SHA1, SHA256, SHA384 | -| dhGroup | enum | Yes | The DH Groups used in IKE Phase 1 for initial SA. - None, DHGroup1, DHGroup2, DHGroup14, DHGroup2048, ECP256, ECP384, DHGroup24 | -| pfsGroup | enum | Yes | The DH Groups used in IKE Phase 2 for new child SA. - None, PFS1, PFS2, PFS2048, ECP256, ECP384, PFS24 | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network gateway ip configuration. - [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | -| vpnClientProtocols | array | No | VpnClientProtocols for Virtual network gateway. - IkeV2 or SSTP | -| radiusServerAddress | string | No | The radius server address property of the VirtualNetworkGateway resource for vpn client connection. | -| radiusServerSecret | string | No | The radius secret property of the VirtualNetworkGateway resource for vpn client connection. | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the vpn client root certificate. - [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the vpn client revoked certificate. - [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-10-01/expressRouteCircuits.md b/test/Resource/Expected/Network/2017-10-01/expressRouteCircuits.md deleted file mode 100644 index 41fa0f5..0000000 --- a/test/Resource/Expected/Network/2017-10-01/expressRouteCircuits.md +++ /dev/null @@ -1,326 +0,0 @@ -# Microsoft.Network/expressRouteCircuits template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "family": "string" - }, - "properties": { - "allowClassicOperations": "boolean", - "circuitProvisioningState": "string", - "serviceProviderProvisioningState": "string", - "authorizations": [ - { - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - }, - "name": "string" - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - "ExpressRouteCircuitPeering" - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - "ExpressRouteCircuitPeering" - ] - } - }, - "state": "string" - } - }, - "name": "string" - } - ], - "serviceKey": "string", - "serviceProviderNotes": "string", - "serviceProviderProperties": { - "serviceProviderName": "string", - "peeringLocation": "string", - "bandwidthInMbps": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The SKU. - [ExpressRouteCircuitSku object](#ExpressRouteCircuitSku) | -| properties | object | Yes | [ExpressRouteCircuitPropertiesFormat object](#ExpressRouteCircuitPropertiesFormat) | -| resources | array | No | [peerings](./expressRouteCircuits/peerings.md) [authorizations](./expressRouteCircuits/authorizations.md) | - - - -### ExpressRouteCircuitSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the SKU. | -| tier | enum | No | The tier of the SKU. Possible values are 'Standard' and 'Premium'. - Standard or Premium | -| family | enum | No | The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. - UnlimitedData or MeteredData | - - - -### ExpressRouteCircuitPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowClassicOperations | boolean | No | Allow classic operations | -| circuitProvisioningState | string | No | The CircuitProvisioningState state of the resource. | -| serviceProviderProvisioningState | enum | No | The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. - NotProvisioned, Provisioning, Provisioned, Deprovisioning | -| authorizations | array | No | The list of authorizations. - [ExpressRouteCircuitAuthorization object](#ExpressRouteCircuitAuthorization) | -| peerings | array | No | The list of peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | -| serviceKey | string | No | The ServiceKey. | -| serviceProviderNotes | string | No | The ServiceProviderNotes. | -| serviceProviderProperties | object | No | The ServiceProviderProperties. - [ExpressRouteCircuitServiceProviderProperties object](#ExpressRouteCircuitServiceProviderProperties) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | - - - -### ExpressRouteCircuitAuthorization object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### ExpressRouteCircuitServiceProviderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceProviderName | string | No | The serviceProviderName. | -| peeringLocation | string | No | The peering location. | -| bandwidthInMbps | integer | No | The BandwidthInMbps. | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-10-01/expressRouteCircuits/authorizations.md b/test/Resource/Expected/Network/2017-10-01/expressRouteCircuits/authorizations.md deleted file mode 100644 index cd7acc0..0000000 --- a/test/Resource/Expected/Network/2017-10-01/expressRouteCircuits/authorizations.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/authorizations template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/authorizations resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/authorizations", - "apiVersion": "2017-10-01", - "id": "string", - "properties": { - "authorizationKey": "string", - "authorizationUseStatus": "string", - "provisioningState": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/authorizations object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/authorizations | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [AuthorizationPropertiesFormat object](#AuthorizationPropertiesFormat) | - - - -### AuthorizationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authorizationKey | string | No | The authorization key. | -| authorizationUseStatus | enum | No | AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. - Available or InUse | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-10-01/expressRouteCircuits/peerings.md b/test/Resource/Expected/Network/2017-10-01/expressRouteCircuits/peerings.md deleted file mode 100644 index 1ea5e6e..0000000 --- a/test/Resource/Expected/Network/2017-10-01/expressRouteCircuits/peerings.md +++ /dev/null @@ -1,239 +0,0 @@ -# Microsoft.Network/expressRouteCircuits/peerings template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/expressRouteCircuits/peerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/expressRouteCircuits/peerings", - "apiVersion": "2017-10-01", - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": "ExpressRouteCircuitPeeringPropertiesFormat", - "name": "string" - } - ] - } - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": "ExpressRouteCircuitPeeringPropertiesFormat", - "name": "string" - } - ] - } - }, - "state": "string" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/expressRouteCircuits/peerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/expressRouteCircuits/peerings | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-10-01/loadBalancers.md b/test/Resource/Expected/Network/2017-10-01/loadBalancers.md deleted file mode 100644 index 1225257..0000000 --- a/test/Resource/Expected/Network/2017-10-01/loadBalancers.md +++ /dev/null @@ -1,719 +0,0 @@ -# Microsoft.Network/loadBalancers template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/loadBalancers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "frontendIPConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "disableBgpRoutePropagation": "boolean", - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "zones": [ - "string" - ] - } - ], - "backendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancingRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "backendAddressPool": { - "id": "string" - }, - "probe": { - "id": "string" - }, - "protocol": "string", - "loadDistribution": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "disableOutboundSnat": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "probes": [ - { - "id": "string", - "properties": { - "protocol": "string", - "port": "integer", - "intervalInSeconds": "integer", - "numberOfProbes": "integer", - "requestPath": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "inboundNatPools": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPortRangeStart": "integer", - "frontendPortRangeEnd": "integer", - "backendPort": "integer", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "outboundNatRules": [ - { - "id": "string", - "properties": { - "allocatedOutboundPorts": "integer", - "frontendIPConfigurations": [ - { - "id": "string" - } - ], - "backendAddressPool": { - "id": "string" - }, - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The load balancer SKU. - [LoadBalancerSku object](#LoadBalancerSku) | -| properties | object | Yes | Properties of load balancer. - [LoadBalancerPropertiesFormat object](#LoadBalancerPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [inboundNatRules](./loadBalancers/inboundNatRules.md) | - - - -### LoadBalancerSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a load balancer SKU. - Basic or Standard | - - - -### LoadBalancerPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfigurations | array | No | Object representing the frontend IPs to be used for the load balancer - [FrontendIPConfiguration object](#FrontendIPConfiguration) | -| backendAddressPools | array | No | Collection of backend address pools used by a load balancer - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancingRules | array | No | Object collection representing the load balancing rules Gets the provisioning - [LoadBalancingRule object](#LoadBalancingRule) | -| probes | array | No | Collection of probe objects used in the load balancer - [Probe object](#Probe) | -| inboundNatRules | array | No | 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. - [InboundNatRule object](#InboundNatRule) | -| inboundNatPools | array | No | 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. - [InboundNatPool object](#InboundNatPool) | -| outboundNatRules | array | No | The outbound NAT rules. - [OutboundNatRule object](#OutboundNatRule) | -| resourceGuid | string | No | The resource GUID property of the load balancer resource. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### FrontendIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the load balancer probe. - [FrontendIPConfigurationPropertiesFormat object](#FrontendIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LoadBalancingRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer load balancing rule. - [LoadBalancingRulePropertiesFormat object](#LoadBalancingRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Probe object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer probe. - [ProbePropertiesFormat object](#ProbePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat pool. - [InboundNatPoolPropertiesFormat object](#InboundNatPoolPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### OutboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer outbound nat rule. - [OutboundNatRulePropertiesFormat object](#OutboundNatRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### FrontendIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAddress | string | No | The private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [Subnet object](#Subnet) | -| publicIPAddress | object | No | The reference of the Public IP resource. - [PublicIPAddress object](#PublicIPAddress) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### LoadBalancingRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| backendAddressPool | object | No | A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| probe | object | No | The reference of the load balancer probe used by the load balancing rule. - [SubResource object](#SubResource) | -| protocol | enum | Yes | Udp, Tcp, All | -| loadDistribution | enum | No | The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. - Default, SourceIP, SourceIPProtocol | -| frontendPort | integer | Yes | 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" | -| backendPort | integer | No | The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| disableOutboundSnat | boolean | No | Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ProbePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | Yes | 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. - Http or Tcp | -| port | integer | Yes | The port for communicating the probe. Possible values range from 1 to 65535, inclusive. | -| intervalInSeconds | integer | No | 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. | -| numberOfProbes | integer | No | 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. | -| requestPath | string | No | 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. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | Udp, Tcp, All | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | Yes | Udp, Tcp, All | -| frontendPortRangeStart | integer | Yes | 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. | -| frontendPortRangeEnd | integer | Yes | 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. | -| backendPort | integer | Yes | The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### OutboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allocatedOutboundPorts | integer | No | The number of outbound ports to be used for NAT. | -| frontendIPConfigurations | array | No | The Frontend IP addresses of the load balancer. - [SubResource object](#SubResource) | -| backendAddressPool | object | Yes | A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. - [SubResource object](#SubResource) | -| provisioningState | string | No | Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| disableBgpRoutePropagation | boolean | No | Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-10-01/loadBalancers/inboundNatRules.md b/test/Resource/Expected/Network/2017-10-01/loadBalancers/inboundNatRules.md deleted file mode 100644 index 687cadd..0000000 --- a/test/Resource/Expected/Network/2017-10-01/loadBalancers/inboundNatRules.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.Network/loadBalancers/inboundNatRules template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/loadBalancers/inboundNatRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/loadBalancers/inboundNatRules", - "apiVersion": "2017-10-01", - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/loadBalancers/inboundNatRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/loadBalancers/inboundNatRules | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | Udp, Tcp, All | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - diff --git a/test/Resource/Expected/Network/2017-10-01/localNetworkGateways.md b/test/Resource/Expected/Network/2017-10-01/localNetworkGateways.md deleted file mode 100644 index 892f49f..0000000 --- a/test/Resource/Expected/Network/2017-10-01/localNetworkGateways.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/localNetworkGateways template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/localNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/localNetworkGateways", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "localNetworkAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "gatewayIpAddress": "string", - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/localNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/localNetworkGateways | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the local network gateway. - [LocalNetworkGatewayPropertiesFormat object](#LocalNetworkGatewayPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### LocalNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| localNetworkAddressSpace | object | No | Local network site address space. - [AddressSpace object](#AddressSpace) | -| gatewayIpAddress | string | No | IP address of local network gateway. | -| bgpSettings | object | No | Local network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the LocalNetworkGateway resource. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - diff --git a/test/Resource/Expected/Network/2017-10-01/networkInterfaces.md b/test/Resource/Expected/Network/2017-10-01/networkInterfaces.md deleted file mode 100644 index 5105664..0000000 --- a/test/Resource/Expected/Network/2017-10-01/networkInterfaces.md +++ /dev/null @@ -1,732 +0,0 @@ -# Microsoft.Network/networkInterfaces template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/networkInterfaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkInterfaces", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "virtualMachine": { - "id": "string" - }, - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "ipConfigurations": [ - { - "id": "string", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "string", - "properties": { - "backendIPConfigurations": [ - "NetworkInterfaceIPConfiguration" - ], - "backendAddresses": [ - { - "fqdn": "string", - "ipAddress": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string", - "type": "string" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "string", - "properties": { - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "string", - "properties": { - "frontendIPConfiguration": { - "id": "string" - }, - "protocol": "string", - "frontendPort": "integer", - "backendPort": "integer", - "idleTimeoutInMinutes": "integer", - "enableFloatingIP": "boolean", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "privateIPAddress": "string", - "privateIPAllocationMethod": "string", - "privateIPAddressVersion": "string", - "subnet": { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "disableBgpRoutePropagation": "boolean", - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - }, - "primary": "boolean", - "publicIPAddress": { - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] - }, - "applicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "dnsSettings": { - "dnsServers": [ - "string" - ], - "appliedDnsServers": [ - "string" - ], - "internalDnsNameLabel": "string", - "internalFqdn": "string", - "internalDomainNameSuffix": "string" - }, - "macAddress": "string", - "primary": "boolean", - "enableAcceleratedNetworking": "boolean", - "enableIPForwarding": "boolean", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkInterfaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkInterfaces | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the network interface. - [NetworkInterfacePropertiesFormat object](#NetworkInterfacePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfacePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualMachine | object | No | The reference of a virtual machine. - [SubResource object](#SubResource) | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| ipConfigurations | array | No | A list of IPConfigurations of the network interface. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| dnsSettings | object | No | The DNS settings in network interface. - [NetworkInterfaceDnsSettings object](#NetworkInterfaceDnsSettings) | -| macAddress | string | No | The MAC address of the network interface. | -| primary | boolean | No | Gets whether this is a primary network interface on a virtual machine. | -| enableAcceleratedNetworking | boolean | No | If the network interface is accelerated networking enabled. | -| enableIPForwarding | boolean | No | Indicates whether IP forwarding is enabled on this network interface. | -| resourceGuid | string | No | The resource GUID property of the network interface resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Network interface IP configuration properties. - [NetworkInterfaceIPConfigurationPropertiesFormat object](#NetworkInterfaceIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### NetworkInterfaceDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | 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. - string | -| appliedDnsServers | array | No | 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. - string | -| internalDnsNameLabel | string | No | Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. | -| internalFqdn | string | No | Fully qualified DNS name supporting internal communications between VMs in the same virtual network. | -| internalDomainNameSuffix | string | No | 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. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### NetworkInterfaceIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| applicationGatewayBackendAddressPools | array | No | The reference of ApplicationGatewayBackendAddressPool resource. - [ApplicationGatewayBackendAddressPool object](#ApplicationGatewayBackendAddressPool) | -| loadBalancerBackendAddressPools | array | No | The reference of LoadBalancerBackendAddressPool resource. - [BackendAddressPool object](#BackendAddressPool) | -| loadBalancerInboundNatRules | array | No | A list of references of LoadBalancerInboundNatRules. - [InboundNatRule object](#InboundNatRule) | -| privateIPAddress | string | No | Private IP address of the IP configuration. | -| privateIPAllocationMethod | enum | No | Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| privateIPAddressVersion | enum | No | 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'. - IPv4 or IPv6 | -| subnet | object | No | Subnet bound to the IP configuration. - [Subnet object](#Subnet) | -| primary | boolean | No | Gets whether this is a primary customer address on the network interface. | -| publicIPAddress | object | No | Public IP address bound to the IP configuration. - [PublicIPAddress object](#PublicIPAddress) | -| applicationSecurityGroups | array | No | Application security groups in which the IP configuration is included. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| provisioningState | string | No | The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### ApplicationGatewayBackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ApplicationGatewayBackendAddressPoolPropertiesFormat object](#ApplicationGatewayBackendAddressPoolPropertiesFormat) | -| name | string | No | Resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| type | string | No | Type of the resource. | - - - -### BackendAddressPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer backend address pool. - [BackendAddressPoolPropertiesFormat object](#BackendAddressPoolPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### InboundNatRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of load balancer inbound nat rule. - [InboundNatRulePropertiesFormat object](#InboundNatRulePropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### PublicIPAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | No | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| backendIPConfigurations | array | No | Collection of references to IPs defined in network interfaces. - [NetworkInterfaceIPConfiguration object](#NetworkInterfaceIPConfiguration) | -| backendAddresses | array | No | Backend addresses - [ApplicationGatewayBackendAddress object](#ApplicationGatewayBackendAddress) | -| provisioningState | string | No | Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### BackendAddressPoolPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| provisioningState | string | No | Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### InboundNatRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| frontendIPConfiguration | object | No | A reference to frontend IP addresses. - [SubResource object](#SubResource) | -| protocol | enum | No | Udp, Tcp, All | -| frontendPort | integer | No | 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. | -| backendPort | integer | No | The port used for the internal endpoint. Acceptable values range from 1 to 65535. | -| idleTimeoutInMinutes | integer | No | The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. | -| enableFloatingIP | boolean | No | Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationGatewayBackendAddress object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| fqdn | string | No | Fully qualified domain name (FQDN). | -| ipAddress | string | No | IP address | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| disableBgpRoutePropagation | boolean | No | Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-10-01/networkSecurityGroups.md b/test/Resource/Expected/Network/2017-10-01/networkSecurityGroups.md deleted file mode 100644 index 1066cd4..0000000 --- a/test/Resource/Expected/Network/2017-10-01/networkSecurityGroups.md +++ /dev/null @@ -1,186 +0,0 @@ -# Microsoft.Network/networkSecurityGroups template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [securityRules](./networkSecurityGroups/securityRules.md) | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-10-01/networkSecurityGroups/securityRules.md b/test/Resource/Expected/Network/2017-10-01/networkSecurityGroups/securityRules.md deleted file mode 100644 index 16db387..0000000 --- a/test/Resource/Expected/Network/2017-10-01/networkSecurityGroups/securityRules.md +++ /dev/null @@ -1,102 +0,0 @@ -# Microsoft.Network/networkSecurityGroups/securityRules template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/networkSecurityGroups/securityRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkSecurityGroups/securityRules", - "apiVersion": "2017-10-01", - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkSecurityGroups/securityRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkSecurityGroups/securityRules | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-10-01/networkWatchers.md b/test/Resource/Expected/Network/2017-10-01/networkWatchers.md deleted file mode 100644 index 3bff72a..0000000 --- a/test/Resource/Expected/Network/2017-10-01/networkWatchers.md +++ /dev/null @@ -1,37 +0,0 @@ -# Microsoft.Network/networkWatchers template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/networkWatchers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "etag": "string", - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| properties | object | Yes | [NetworkWatcherPropertiesFormat object](#NetworkWatcherPropertiesFormat) | -| resources | array | No | [connectionMonitors](./networkWatchers/connectionMonitors.md) [packetCaptures](./networkWatchers/packetCaptures.md) | - diff --git a/test/Resource/Expected/Network/2017-10-01/networkWatchers/connectionMonitors.md b/test/Resource/Expected/Network/2017-10-01/networkWatchers/connectionMonitors.md deleted file mode 100644 index 5ee11d1..0000000 --- a/test/Resource/Expected/Network/2017-10-01/networkWatchers/connectionMonitors.md +++ /dev/null @@ -1,70 +0,0 @@ -# Microsoft.Network/networkWatchers/connectionMonitors template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/networkWatchers/connectionMonitors resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers/connectionMonitors", - "apiVersion": "2017-10-01", - "location": "string", - "tags": {}, - "properties": { - "source": { - "resourceId": "string", - "port": "integer" - }, - "destination": { - "resourceId": "string", - "address": "string", - "port": "integer" - }, - "autoStart": "boolean", - "monitoringIntervalInSeconds": "integer" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers/connectionMonitors object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers/connectionMonitors | -| apiVersion | enum | Yes | 2017-10-01 | -| location | string | No | Connection monitor location. | -| tags | object | No | Connection monitor tags. | -| properties | object | Yes | [ConnectionMonitorParameters object](#ConnectionMonitorParameters) | - - - -### ConnectionMonitorParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| source | object | Yes | [ConnectionMonitorSource object](#ConnectionMonitorSource) | -| destination | object | Yes | [ConnectionMonitorDestination object](#ConnectionMonitorDestination) | -| autoStart | boolean | No | Determines if the connection monitor will start automatically once created. | -| monitoringIntervalInSeconds | integer | No | Monitoring interval in seconds. | - - - -### ConnectionMonitorSource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| resourceId | string | Yes | The ID of the resource used as the source by connection monitor. | -| port | integer | No | The source port used by connection monitor. | - - - -### ConnectionMonitorDestination object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| resourceId | string | No | The ID of the resource used as the destination by connection monitor. | -| address | string | No | Address of the connection monitor destination (IP or domain name). | -| port | integer | No | The destination port used by connection monitor. | - diff --git a/test/Resource/Expected/Network/2017-10-01/networkWatchers/packetCaptures.md b/test/Resource/Expected/Network/2017-10-01/networkWatchers/packetCaptures.md deleted file mode 100644 index 7ca0ea6..0000000 --- a/test/Resource/Expected/Network/2017-10-01/networkWatchers/packetCaptures.md +++ /dev/null @@ -1,78 +0,0 @@ -# Microsoft.Network/networkWatchers/packetCaptures template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/networkWatchers/packetCaptures resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/networkWatchers/packetCaptures", - "apiVersion": "2017-10-01", - "properties": { - "target": "string", - "bytesToCapturePerPacket": "integer", - "totalBytesPerSession": "integer", - "timeLimitInSeconds": "integer", - "storageLocation": { - "storageId": "string", - "storagePath": "string", - "filePath": "string" - }, - "filters": [ - { - "protocol": "string", - "localIPAddress": "string", - "remoteIPAddress": "string", - "localPort": "string", - "remotePort": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/networkWatchers/packetCaptures object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/networkWatchers/packetCaptures | -| apiVersion | enum | Yes | 2017-10-01 | -| properties | object | Yes | [PacketCaptureParameters object](#PacketCaptureParameters) | - - - -### PacketCaptureParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| target | string | Yes | The ID of the targeted resource, only VM is currently supported. | -| bytesToCapturePerPacket | integer | No | Number of bytes captured per packet, the remaining bytes are truncated. | -| totalBytesPerSession | integer | No | Maximum size of the capture output. | -| timeLimitInSeconds | integer | No | Maximum duration of the capture session in seconds. | -| storageLocation | object | Yes | [PacketCaptureStorageLocation object](#PacketCaptureStorageLocation) | -| filters | array | No | [PacketCaptureFilter object](#PacketCaptureFilter) | - - - -### PacketCaptureStorageLocation object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageId | string | No | The ID of the storage account to save the packet capture session. Required if no local file path is provided. | -| storagePath | string | No | 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. | -| filePath | string | No | 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. | - - - -### PacketCaptureFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| protocol | enum | No | Protocol to be filtered on. - TCP, UDP, Any | -| localIPAddress | string | No | Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. | -| remoteIPAddress | string | No | 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 | No | 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. | -| remotePort | string | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-10-01/publicIPAddresses.md b/test/Resource/Expected/Network/2017-10-01/publicIPAddresses.md deleted file mode 100644 index 9e6f7a5..0000000 --- a/test/Resource/Expected/Network/2017-10-01/publicIPAddresses.md +++ /dev/null @@ -1,84 +0,0 @@ -# Microsoft.Network/publicIPAddresses template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/publicIPAddresses", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "sku": { - "name": "string" - }, - "properties": { - "publicIPAllocationMethod": "string", - "publicIPAddressVersion": "string", - "dnsSettings": { - "domainNameLabel": "string", - "fqdn": "string", - "reverseFqdn": "string" - }, - "ipAddress": "string", - "idleTimeoutInMinutes": "integer", - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string", - "zones": [ - "string" - ] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/publicIPAddresses object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/publicIPAddresses | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | The public IP address SKU. - [PublicIPAddressSku object](#PublicIPAddressSku) | -| properties | object | Yes | Public IP address properties. - [PublicIPAddressPropertiesFormat object](#PublicIPAddressPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | -| zones | array | No | A list of availability zones denoting the IP allocated for the resource needs to come from. - string | - - - -### PublicIPAddressSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of a public IP address SKU. - Basic or Standard | - - - -### PublicIPAddressPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicIPAllocationMethod | enum | No | The public IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| publicIPAddressVersion | enum | No | The public IP address version. Possible values are: 'IPv4' and 'IPv6'. - IPv4 or IPv6 | -| dnsSettings | object | No | The FQDN of the DNS record associated with the public IP address. - [PublicIPAddressDnsSettings object](#PublicIPAddressDnsSettings) | -| ipAddress | string | No | The IP address associated with the public IP address resource. | -| idleTimeoutInMinutes | integer | No | The idle timeout of the public IP address. | -| resourceGuid | string | No | The resource GUID property of the public IP resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### PublicIPAddressDnsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| domainNameLabel | string | No | 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 | No | 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 | No | 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. | - diff --git a/test/Resource/Expected/Network/2017-10-01/routeFilters.md b/test/Resource/Expected/Network/2017-10-01/routeFilters.md deleted file mode 100644 index 559fcb9..0000000 --- a/test/Resource/Expected/Network/2017-10-01/routeFilters.md +++ /dev/null @@ -1,222 +0,0 @@ -# Microsoft.Network/routeFilters template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/routeFilters resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "rules": [ - { - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "name": "string", - "location": "string", - "tags": {} - } - ], - "peerings": [ - { - "id": "string", - "properties": { - "peeringType": "string", - "state": "string", - "azureASN": "integer", - "peerASN": "integer", - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "primaryAzurePort": "string", - "secondaryAzurePort": "string", - "sharedKey": "string", - "vlanId": "integer", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "stats": { - "primarybytesIn": "integer", - "primarybytesOut": "integer", - "secondarybytesIn": "integer", - "secondarybytesOut": "integer" - }, - "provisioningState": "string", - "gatewayManagerEtag": "string", - "lastModifiedBy": "string", - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "RouteFilterPropertiesFormat" - }, - "ipv6PeeringConfig": { - "primaryPeerAddressPrefix": "string", - "secondaryPeerAddressPrefix": "string", - "microsoftPeeringConfig": { - "advertisedPublicPrefixes": [ - "string" - ], - "advertisedCommunities": [ - "string" - ], - "advertisedPublicPrefixesState": "string", - "legacyMode": "integer", - "customerASN": "integer", - "routingRegistryName": "string" - }, - "routeFilter": { - "id": "string", - "location": "string", - "tags": {}, - "properties": "RouteFilterPropertiesFormat" - }, - "state": "string" - } - }, - "name": "string" - } - ] - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | -| resources | array | No | [routeFilterRules](./routeFilters/routeFilterRules.md) | - - - -### RouteFilterPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rules | array | No | Collection of RouteFilterRules contained within a route filter. - [RouteFilterRule object](#RouteFilterRule) | -| peerings | array | No | A collection of references to express route circuit peerings. - [ExpressRouteCircuitPeering object](#ExpressRouteCircuitPeering) | - - - -### RouteFilterRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### ExpressRouteCircuitPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | [ExpressRouteCircuitPeeringPropertiesFormat object](#ExpressRouteCircuitPeeringPropertiesFormat) | -| name | string | No | Gets name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - - - -### ExpressRouteCircuitPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| peeringType | enum | No | The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. - AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | -| azureASN | integer | No | The Azure ASN. | -| peerASN | integer | No | The peer ASN. | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| primaryAzurePort | string | No | The primary port. | -| secondaryAzurePort | string | No | The secondary port. | -| sharedKey | string | No | The shared key. | -| vlanId | integer | No | The VLAN ID. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| stats | object | No | Gets peering stats. - [ExpressRouteCircuitStats object](#ExpressRouteCircuitStats) | -| provisioningState | string | No | Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| gatewayManagerEtag | string | No | The GatewayManager Etag. | -| lastModifiedBy | string | No | Gets whether the provider or the customer last modified the peering. | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| ipv6PeeringConfig | object | No | The IPv6 peering configuration. - [Ipv6ExpressRouteCircuitPeeringConfig object](#Ipv6ExpressRouteCircuitPeeringConfig) | - - - -### ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| advertisedPublicPrefixes | array | No | The reference of AdvertisedPublicPrefixes. - string | -| advertisedCommunities | array | No | The communities of bgp peering. Spepcified for microsoft peering - string | -| advertisedPublicPrefixesState | enum | No | AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. - NotConfigured, Configuring, Configured, ValidationNeeded | -| legacyMode | integer | No | The legacy mode of the peering. | -| customerASN | integer | No | The CustomerASN of the peering. | -| routingRegistryName | string | No | The RoutingRegistryName of the configuration. | - - - -### ExpressRouteCircuitStats object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primarybytesIn | integer | No | Gets BytesIn of the peering. | -| primarybytesOut | integer | No | Gets BytesOut of the peering. | -| secondarybytesIn | integer | No | Gets BytesIn of the peering. | -| secondarybytesOut | integer | No | Gets BytesOut of the peering. | - - - -### RouteFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | [RouteFilterPropertiesFormat object](#RouteFilterPropertiesFormat) | - - - -### Ipv6ExpressRouteCircuitPeeringConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| primaryPeerAddressPrefix | string | No | The primary address prefix. | -| secondaryPeerAddressPrefix | string | No | The secondary address prefix. | -| microsoftPeeringConfig | object | No | The Microsoft peering configuration. - [ExpressRouteCircuitPeeringConfig object](#ExpressRouteCircuitPeeringConfig) | -| routeFilter | object | No | The reference of the RouteFilter resource. - [RouteFilter object](#RouteFilter) | -| state | enum | No | The state of peering. Possible values are: 'Disabled' and 'Enabled'. - Disabled or Enabled | - diff --git a/test/Resource/Expected/Network/2017-10-01/routeFilters/routeFilterRules.md b/test/Resource/Expected/Network/2017-10-01/routeFilters/routeFilterRules.md deleted file mode 100644 index 4d7bd17..0000000 --- a/test/Resource/Expected/Network/2017-10-01/routeFilters/routeFilterRules.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.Network/routeFilters/routeFilterRules template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/routeFilters/routeFilterRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeFilters/routeFilterRules", - "apiVersion": "2017-10-01", - "id": "string", - "properties": { - "access": "string", - "routeFilterRuleType": "Community", - "communities": [ - "string" - ] - }, - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeFilters/routeFilterRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeFilters/routeFilterRules | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | [RouteFilterRulePropertiesFormat object](#RouteFilterRulePropertiesFormat) | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | - - - -### RouteFilterRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| access | enum | Yes | The access type of the rule. Valid values are: 'Allow', 'Deny'. - Allow or Deny | -| routeFilterRuleType | enum | Yes | The rule type of the rule. Valid value is: 'Community' - Community | -| communities | array | Yes | The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] - string | - diff --git a/test/Resource/Expected/Network/2017-10-01/routeTables.md b/test/Resource/Expected/Network/2017-10-01/routeTables.md deleted file mode 100644 index 1e4530f..0000000 --- a/test/Resource/Expected/Network/2017-10-01/routeTables.md +++ /dev/null @@ -1,82 +0,0 @@ -# Microsoft.Network/routeTables template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/routeTables resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "disableBgpRoutePropagation": "boolean", - "provisioningState": "string" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [routes](./routeTables/routes.md) | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| disableBgpRoutePropagation | boolean | No | Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-10-01/routeTables/routes.md b/test/Resource/Expected/Network/2017-10-01/routeTables/routes.md deleted file mode 100644 index c9f2d38..0000000 --- a/test/Resource/Expected/Network/2017-10-01/routeTables/routes.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Network/routeTables/routes template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/routeTables/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/routeTables/routes", - "apiVersion": "2017-10-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/routeTables/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/routeTables/routes | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - diff --git a/test/Resource/Expected/Network/2017-10-01/virtualNetworkGateways.md b/test/Resource/Expected/Network/2017-10-01/virtualNetworkGateways.md deleted file mode 100644 index 1bf6c78..0000000 --- a/test/Resource/Expected/Network/2017-10-01/virtualNetworkGateways.md +++ /dev/null @@ -1,215 +0,0 @@ -# Microsoft.Network/virtualNetworkGateways template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/virtualNetworkGateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworkGateways", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "ipConfigurations": [ - { - "id": "string", - "properties": { - "privateIPAllocationMethod": "string", - "subnet": { - "id": "string" - }, - "publicIPAddress": { - "id": "string" - } - }, - "name": "string", - "etag": "string" - } - ], - "gatewayType": "string", - "vpnType": "string", - "enableBgp": "boolean", - "activeActive": "boolean", - "gatewayDefaultSite": { - "id": "string" - }, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "vpnClientConfiguration": { - "vpnClientAddressPool": { - "addressPrefixes": [ - "string" - ] - }, - "vpnClientRootCertificates": [ - { - "id": "string", - "properties": { - "publicCertData": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientRevokedCertificates": [ - { - "id": "string", - "properties": { - "thumbprint": "string" - }, - "name": "string", - "etag": "string" - } - ], - "vpnClientProtocols": [ - "string" - ], - "radiusServerAddress": "string", - "radiusServerSecret": "string" - }, - "bgpSettings": { - "asn": "integer", - "bgpPeeringAddress": "string", - "peerWeight": "integer" - }, - "resourceGuid": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworkGateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworkGateways | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network gateway. - [VirtualNetworkGatewayPropertiesFormat object](#VirtualNetworkGatewayPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkGatewayPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipConfigurations | array | No | IP configurations for virtual network gateway. - [VirtualNetworkGatewayIPConfiguration object](#VirtualNetworkGatewayIPConfiguration) | -| gatewayType | enum | No | The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. - Vpn or ExpressRoute | -| vpnType | enum | No | The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - PolicyBased or RouteBased | -| enableBgp | boolean | No | Whether BGP is enabled for this virtual network gateway or not. | -| activeActive | boolean | No | ActiveActive flag | -| gatewayDefaultSite | object | No | The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. - [SubResource object](#SubResource) | -| sku | object | No | The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. - [VirtualNetworkGatewaySku object](#VirtualNetworkGatewaySku) | -| vpnClientConfiguration | object | No | The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations. - [VpnClientConfiguration object](#VpnClientConfiguration) | -| bgpSettings | object | No | Virtual network gateway's BGP speaker settings. - [BgpSettings object](#BgpSettings) | -| resourceGuid | string | No | The resource GUID property of the VirtualNetworkGateway resource. | - - - -### VirtualNetworkGatewayIPConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network gateway ip configuration. - [VirtualNetworkGatewayIPConfigurationPropertiesFormat object](#VirtualNetworkGatewayIPConfigurationPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### VirtualNetworkGatewaySku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Gateway SKU name. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| tier | enum | No | Gateway SKU tier. - Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3 | -| capacity | integer | No | The capacity. | - - - -### VpnClientConfiguration object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vpnClientAddressPool | object | No | The reference of the address space resource which represents Address space for P2S VpnClient. - [AddressSpace object](#AddressSpace) | -| vpnClientRootCertificates | array | No | VpnClientRootCertificate for virtual network gateway. - [VpnClientRootCertificate object](#VpnClientRootCertificate) | -| vpnClientRevokedCertificates | array | No | VpnClientRevokedCertificate for Virtual network gateway. - [VpnClientRevokedCertificate object](#VpnClientRevokedCertificate) | -| vpnClientProtocols | array | No | VpnClientProtocols for Virtual network gateway. - IkeV2 or SSTP | -| radiusServerAddress | string | No | The radius server address property of the VirtualNetworkGateway resource for vpn client connection. | -| radiusServerSecret | string | No | The radius secret property of the VirtualNetworkGateway resource for vpn client connection. | - - - -### BgpSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| asn | integer | No | The BGP speaker's ASN. | -| bgpPeeringAddress | string | No | The BGP peering address and BGP identifier of this BGP speaker. | -| peerWeight | integer | No | The weight added to routes learned from this BGP speaker. | - - - -### VirtualNetworkGatewayIPConfigurationPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| privateIPAllocationMethod | enum | No | The private IP allocation method. Possible values are: 'Static' and 'Dynamic'. - Static or Dynamic | -| subnet | object | No | The reference of the subnet resource. - [SubResource object](#SubResource) | -| publicIPAddress | object | No | The reference of the public IP resource. - [SubResource object](#SubResource) | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### VpnClientRootCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the vpn client root certificate. - [VpnClientRootCertificatePropertiesFormat object](#VpnClientRootCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRevokedCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the vpn client revoked certificate. - [VpnClientRevokedCertificatePropertiesFormat object](#VpnClientRevokedCertificatePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VpnClientRootCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| publicCertData | string | Yes | The certificate public data. | - - - -### VpnClientRevokedCertificatePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | No | The revoked VPN client certificate thumbprint. | - diff --git a/test/Resource/Expected/Network/2017-10-01/virtualNetworks.md b/test/Resource/Expected/Network/2017-10-01/virtualNetworks.md deleted file mode 100644 index d290351..0000000 --- a/test/Resource/Expected/Network/2017-10-01/virtualNetworks.md +++ /dev/null @@ -1,442 +0,0 @@ -# Microsoft.Network/virtualNetworks template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/virtualNetworks resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks", - "apiVersion": "2017-10-01", - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "addressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "string" - ] - }, - "subnets": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "disableBgpRoutePropagation": "boolean", - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "virtualNetworkPeerings": [ - { - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "remoteAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "peeringState": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string", - "enableDdosProtection": "boolean", - "enableVmProtection": "boolean" - }, - "etag": "string", - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Properties of the virtual network. - [VirtualNetworkPropertiesFormat object](#VirtualNetworkPropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | -| resources | array | No | [virtualNetworkPeerings](./virtualNetworks/virtualNetworkPeerings.md) [subnets](./virtualNetworks/subnets.md) | - - - -### VirtualNetworkPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressSpace | object | No | The AddressSpace that contains an array of IP address ranges that can be used by subnets. - [AddressSpace object](#AddressSpace) | -| dhcpOptions | object | No | The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. - [DhcpOptions object](#DhcpOptions) | -| subnets | array | No | A list of subnets in a Virtual Network. - [Subnet object](#Subnet) | -| virtualNetworkPeerings | array | No | A list of peerings in a Virtual Network. - [VirtualNetworkPeering object](#VirtualNetworkPeering) | -| resourceGuid | string | No | The resourceGuid property of the Virtual Network resource. | -| provisioningState | string | No | The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | -| enableDdosProtection | boolean | No | Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. | -| enableVmProtection | boolean | No | Indicates if Vm protection is enabled for all the subnets in a Virtual Network. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - - - -### DhcpOptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dnsServers | array | No | The list of DNS servers IP addresses. - string | - - - -### Subnet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeering object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the virtual network peering. - [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). - [SubResource object](#SubResource) | -| remoteAddressSpace | object | No | The reference of the remote virtual network address space. - [AddressSpace object](#AddressSpace) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| disableBgpRoutePropagation | boolean | No | Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-10-01/virtualNetworks/subnets.md b/test/Resource/Expected/Network/2017-10-01/virtualNetworks/subnets.md deleted file mode 100644 index 647dcfc..0000000 --- a/test/Resource/Expected/Network/2017-10-01/virtualNetworks/subnets.md +++ /dev/null @@ -1,321 +0,0 @@ -# Microsoft.Network/virtualNetworks/subnets template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/subnets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/subnets", - "apiVersion": "2017-10-01", - "id": "string", - "properties": { - "addressPrefix": "string", - "networkSecurityGroup": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "securityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "defaultSecurityRules": [ - { - "id": "string", - "properties": { - "description": "string", - "protocol": "string", - "sourcePortRange": "string", - "destinationPortRange": "string", - "sourceAddressPrefix": "string", - "sourceAddressPrefixes": [ - "string" - ], - "sourceApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "destinationAddressPrefix": "string", - "destinationAddressPrefixes": [ - "string" - ], - "destinationApplicationSecurityGroups": [ - { - "id": "string", - "location": "string", - "tags": {}, - "properties": {} - } - ], - "sourcePortRanges": [ - "string" - ], - "destinationPortRanges": [ - "string" - ], - "access": "string", - "priority": "integer", - "direction": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "resourceGuid": "string", - "provisioningState": "string" - }, - "etag": "string" - }, - "routeTable": { - "id": "string", - "location": "string", - "tags": {}, - "properties": { - "routes": [ - { - "id": "string", - "properties": { - "addressPrefix": "string", - "nextHopType": "string", - "nextHopIpAddress": "string", - "provisioningState": "string" - }, - "name": "string", - "etag": "string" - } - ], - "disableBgpRoutePropagation": "boolean", - "provisioningState": "string" - }, - "etag": "string" - }, - "serviceEndpoints": [ - { - "service": "string", - "locations": [ - "string" - ], - "provisioningState": "string" - } - ], - "resourceNavigationLinks": [ - { - "id": "string", - "properties": { - "linkedResourceType": "string", - "link": "string" - }, - "name": "string" - } - ], - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/subnets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/subnets | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the subnet. - [SubnetPropertiesFormat object](#SubnetPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SubnetPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The address prefix for the subnet. | -| networkSecurityGroup | object | No | The reference of the NetworkSecurityGroup resource. - [NetworkSecurityGroup object](#NetworkSecurityGroup) | -| routeTable | object | No | The reference of the RouteTable resource. - [RouteTable object](#RouteTable) | -| serviceEndpoints | array | No | An array of service endpoints. - [ServiceEndpointPropertiesFormat object](#ServiceEndpointPropertiesFormat) | -| resourceNavigationLinks | array | No | Gets an array of references to the external resources using subnet. - [ResourceNavigationLink object](#ResourceNavigationLink) | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### NetworkSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the network security group - [NetworkSecurityGroupPropertiesFormat object](#NetworkSecurityGroupPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### RouteTable object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the route table. - [RouteTablePropertiesFormat object](#RouteTablePropertiesFormat) | -| etag | string | No | Gets a unique read-only string that changes whenever the resource is updated. | - - - -### ServiceEndpointPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| service | string | No | The type of the endpoint service. | -| locations | array | No | A list of locations. - string | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### ResourceNavigationLink object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Resource navigation link properties format. - [ResourceNavigationLinkFormat object](#ResourceNavigationLinkFormat) | -| name | string | No | Name of the resource that is unique within a resource group. This name can be used to access the resource. | - - - -### NetworkSecurityGroupPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| securityRules | array | No | A collection of security rules of the network security group. - [SecurityRule object](#SecurityRule) | -| defaultSecurityRules | array | No | The default security rules of network security group. - [SecurityRule object](#SecurityRule) | -| resourceGuid | string | No | The resource GUID property of the network security group resource. | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RouteTablePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| routes | array | No | Collection of routes contained within a route table. - [Route object](#Route) | -| disableBgpRoutePropagation | boolean | No | Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ResourceNavigationLinkFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| linkedResourceType | string | No | Resource type of the linked resource. | -| link | string | No | Link to the external resource | - - - -### SecurityRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the security rule - [SecurityRulePropertiesFormat object](#SecurityRulePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### Route object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| properties | object | No | Properties of the route. - [RoutePropertiesFormat object](#RoutePropertiesFormat) | -| name | string | No | The name of the resource that is unique within a resource group. This name can be used to access the resource. | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### SecurityRulePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| description | string | No | A description for this rule. Restricted to 140 chars. | -| protocol | enum | Yes | Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. - Tcp, Udp, * | -| sourcePortRange | string | No | The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| destinationPortRange | string | No | The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports. | -| sourceAddressPrefix | string | No | The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. | -| sourceAddressPrefixes | array | No | The CIDR or source IP ranges. - string | -| sourceApplicationSecurityGroups | array | No | The application security group specified as source. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| destinationAddressPrefix | string | No | The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. | -| destinationAddressPrefixes | array | No | The destination address prefixes. CIDR or destination IP ranges. - string | -| destinationApplicationSecurityGroups | array | No | The application security group specified as destination. - [ApplicationSecurityGroup object](#ApplicationSecurityGroup) | -| sourcePortRanges | array | No | The source port ranges. - string | -| destinationPortRanges | array | No | The destination port ranges. - string | -| access | enum | Yes | The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. - Allow or Deny | -| priority | integer | No | 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. | -| direction | enum | Yes | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'. - Inbound or Outbound | -| provisioningState | string | No | The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### RoutePropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefix | string | No | The destination CIDR to which the route applies. | -| nextHopType | enum | Yes | The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. - VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None | -| nextHopIpAddress | string | No | The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. | -| provisioningState | string | No | The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. | - - - -### ApplicationSecurityGroup object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | -| location | string | No | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | No | Properties of the application security group. - [ApplicationSecurityGroupPropertiesFormat object](#ApplicationSecurityGroupPropertiesFormat) | - diff --git a/test/Resource/Expected/Network/2017-10-01/virtualNetworks/virtualNetworkPeerings.md b/test/Resource/Expected/Network/2017-10-01/virtualNetworks/virtualNetworkPeerings.md deleted file mode 100644 index 1dac077..0000000 --- a/test/Resource/Expected/Network/2017-10-01/virtualNetworks/virtualNetworkPeerings.md +++ /dev/null @@ -1,74 +0,0 @@ -# Microsoft.Network/virtualNetworks/virtualNetworkPeerings template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Network/virtualNetworks/virtualNetworkPeerings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Network/virtualNetworks/virtualNetworkPeerings", - "apiVersion": "2017-10-01", - "id": "string", - "properties": { - "allowVirtualNetworkAccess": "boolean", - "allowForwardedTraffic": "boolean", - "allowGatewayTransit": "boolean", - "useRemoteGateways": "boolean", - "remoteVirtualNetwork": { - "id": "string" - }, - "remoteAddressSpace": { - "addressPrefixes": [ - "string" - ] - }, - "peeringState": "string", - "provisioningState": "string" - }, - "etag": "string" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Network/virtualNetworks/virtualNetworkPeerings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Network/virtualNetworks/virtualNetworkPeerings | -| apiVersion | enum | Yes | 2017-10-01 | -| id | string | No | Resource ID. | -| properties | object | Yes | Properties of the virtual network peering. - [VirtualNetworkPeeringPropertiesFormat object](#VirtualNetworkPeeringPropertiesFormat) | -| etag | string | No | A unique read-only string that changes whenever the resource is updated. | - - - -### VirtualNetworkPeeringPropertiesFormat object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowVirtualNetworkAccess | boolean | No | Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space. | -| allowForwardedTraffic | boolean | No | Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed. | -| allowGatewayTransit | boolean | No | If gateway links can be used in remote virtual networking to link to this virtual network. | -| useRemoteGateways | boolean | No | 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. | -| remoteVirtualNetwork | object | No | The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). - [SubResource object](#SubResource) | -| remoteAddressSpace | object | No | The reference of the remote virtual network address space. - [AddressSpace object](#AddressSpace) | -| peeringState | enum | No | The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. - Initiated, Connected, Disconnected | -| provisioningState | string | No | The provisioning state of the resource. | - - - -### SubResource object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID. | - - - -### AddressSpace object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressPrefixes | array | No | A list of address blocks reserved for this virtual network in CIDR notation. - string | - diff --git a/test/Resource/Expected/RecoveryServices/2016-06-01/Microsoft.RecoveryServices.json b/test/Resource/Expected/RecoveryServices/2016-06-01/Microsoft.RecoveryServices.json deleted file mode 100644 index 6fade8f..0000000 --- a/test/Resource/Expected/RecoveryServices/2016-06-01/Microsoft.RecoveryServices.json +++ /dev/null @@ -1,249 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-06-01/Microsoft.RecoveryServices.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.RecoveryServices", - "description": "Microsoft RecoveryServices Resource Types", - "resourceDefinitions": { - "vaults": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the recovery services vault." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.RecoveryServices/vaults" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "eTag": { - "type": "string", - "description": "Optional ETag." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VaultProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/vaults_certificates_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.RecoveryServices/vaults" - }, - "vaults_certificates": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.RecoveryServices/vaults/certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RawCertificateData" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.RecoveryServices/vaults/certificates" - } - }, - "definitions": { - "RawCertificateData": { - "type": "object", - "properties": { - "authType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Invalid", - "ACS", - "AAD", - "AccessControlService", - "AzureActiveDirectory" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the authentication type." - }, - "certificate": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The base64 encoded certificate raw data string" - } - }, - "description": "Raw certificate data." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "RS0" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The Sku name." - } - }, - "required": [ - "name" - ], - "description": "Identifies the unique system identifier for each Azure resource." - }, - "UpgradeDetails": { - "type": "object", - "properties": {}, - "description": "Details for upgrading vault." - }, - "VaultProperties": { - "type": "object", - "properties": { - "upgradeDetails": { - "oneOf": [ - { - "$ref": "#/definitions/UpgradeDetails" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "description": "Properties of the vault." - }, - "vaults_certificates_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-06-01" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RawCertificateData" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.RecoveryServices/vaults/certificates" - } - } -} diff --git a/test/Resource/Expected/RecoveryServices/2016-06-01/vaults.md b/test/Resource/Expected/RecoveryServices/2016-06-01/vaults.md deleted file mode 100644 index 5db8d5f..0000000 --- a/test/Resource/Expected/RecoveryServices/2016-06-01/vaults.md +++ /dev/null @@ -1,55 +0,0 @@ -# Microsoft.RecoveryServices/vaults template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.RecoveryServices/vaults resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.RecoveryServices/vaults", - "apiVersion": "2016-06-01", - "eTag": "string", - "location": "string", - "tags": {}, - "properties": { - "upgradeDetails": {} - }, - "sku": { - "name": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.RecoveryServices/vaults object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the recovery services vault. | -| type | enum | Yes | Microsoft.RecoveryServices/vaults | -| apiVersion | enum | Yes | 2016-06-01 | -| eTag | string | No | Optional ETag. | -| location | string | Yes | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [VaultProperties object](#VaultProperties) | -| sku | object | No | [Sku object](#Sku) | -| resources | array | No | [certificates](./vaults/certificates.md) | - - - -### VaultProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| upgradeDetails | object | No | [UpgradeDetails object](#UpgradeDetails) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The Sku name. - Standard or RS0 | - diff --git a/test/Resource/Expected/RecoveryServices/2016-06-01/vaults/certificates.md b/test/Resource/Expected/RecoveryServices/2016-06-01/vaults/certificates.md deleted file mode 100644 index 664808a..0000000 --- a/test/Resource/Expected/RecoveryServices/2016-06-01/vaults/certificates.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.RecoveryServices/vaults/certificates template reference -API Version: 2016-06-01 -## Template format - -To create a Microsoft.RecoveryServices/vaults/certificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.RecoveryServices/vaults/certificates", - "apiVersion": "2016-06-01", - "properties": { - "authType": "string", - "certificate": [ - "integer" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.RecoveryServices/vaults/certificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.RecoveryServices/vaults/certificates | -| apiVersion | enum | Yes | 2016-06-01 | -| properties | object | Yes | [RawCertificateData object](#RawCertificateData) | - - - -### RawCertificateData object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| authType | enum | No | Specifies the authentication type. - Invalid, ACS, AAD, AccessControlService, AzureActiveDirectory | -| certificate | array | No | The base64 encoded certificate raw data string - integer | - diff --git a/test/Resource/Expected/Relay/2016-07-01/namespaces.md b/test/Resource/Expected/Relay/2016-07-01/namespaces.md deleted file mode 100644 index eb028db..0000000 --- a/test/Resource/Expected/Relay/2016-07-01/namespaces.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Relay/namespaces template reference -API Version: 2016-07-01 -## Template format - -To create a Microsoft.Relay/namespaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces", - "apiVersion": "2016-07-01", - "location": "string", - "tags": {}, - "sku": { - "name": "Standard", - "tier": "Standard" - }, - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The Namespace Name | -| type | enum | Yes | Microsoft.Relay/namespaces | -| apiVersion | enum | Yes | 2016-07-01 | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| sku | object | No | Sku of the Namespace. - [Sku object](#Sku) | -| properties | object | Yes | Description of Relay Namespace - [RelayNamespaceProperties object](#RelayNamespaceProperties) | -| resources | array | No | [WcfRelays](./namespaces/WcfRelays.md) [HybridConnections](./namespaces/HybridConnections.md) [AuthorizationRules](./namespaces/AuthorizationRules.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Name of this Sku - Standard | -| tier | enum | Yes | The tier of this particular SKU - Standard | - diff --git a/test/Resource/Expected/Relay/2016-07-01/namespaces/AuthorizationRules.md b/test/Resource/Expected/Relay/2016-07-01/namespaces/AuthorizationRules.md deleted file mode 100644 index 16d1eb5..0000000 --- a/test/Resource/Expected/Relay/2016-07-01/namespaces/AuthorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.Relay/namespaces/AuthorizationRules template reference -API Version: 2016-07-01 -## Template format - -To create a Microsoft.Relay/namespaces/AuthorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/AuthorizationRules", - "apiVersion": "2016-07-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/AuthorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorizationRule name. | -| type | enum | Yes | Microsoft.Relay/namespaces/AuthorizationRules | -| apiVersion | enum | Yes | 2016-07-01 | -| properties | object | Yes | Authorization Rule properties - [AuthorizationRuleProperties object](#AuthorizationRuleProperties) | - - - -### AuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/Relay/2016-07-01/namespaces/HybridConnections.md b/test/Resource/Expected/Relay/2016-07-01/namespaces/HybridConnections.md deleted file mode 100644 index 4917da1..0000000 --- a/test/Resource/Expected/Relay/2016-07-01/namespaces/HybridConnections.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Relay/namespaces/HybridConnections template reference -API Version: 2016-07-01 -## Template format - -To create a Microsoft.Relay/namespaces/HybridConnections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/HybridConnections", - "apiVersion": "2016-07-01", - "properties": { - "requiresClientAuthorization": "boolean", - "userMetadata": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/HybridConnections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The hybrid connection name. | -| type | enum | Yes | Microsoft.Relay/namespaces/HybridConnections | -| apiVersion | enum | Yes | 2016-07-01 | -| properties | object | Yes | Properties of HybridConnection - [HybridConnectionProperties object](#HybridConnectionProperties) | -| resources | array | No | [authorizationRules](./HybridConnections/authorizationRules.md) | - - - -### HybridConnectionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| requiresClientAuthorization | boolean | No | true if client authorization is needed for this HybridConnection; otherwise, false. | -| userMetadata | string | No | 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. | - diff --git a/test/Resource/Expected/Relay/2016-07-01/namespaces/HybridConnections/authorizationRules.md b/test/Resource/Expected/Relay/2016-07-01/namespaces/HybridConnections/authorizationRules.md deleted file mode 100644 index ba08c00..0000000 --- a/test/Resource/Expected/Relay/2016-07-01/namespaces/HybridConnections/authorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.Relay/namespaces/HybridConnections/authorizationRules template reference -API Version: 2016-07-01 -## Template format - -To create a Microsoft.Relay/namespaces/HybridConnections/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/HybridConnections/authorizationRules", - "apiVersion": "2016-07-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/HybridConnections/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorizationRule name. | -| type | enum | Yes | Microsoft.Relay/namespaces/HybridConnections/authorizationRules | -| apiVersion | enum | Yes | 2016-07-01 | -| properties | object | Yes | Authorization Rule properties - [AuthorizationRuleProperties object](#AuthorizationRuleProperties) | - - - -### AuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/Relay/2016-07-01/namespaces/WcfRelays.md b/test/Resource/Expected/Relay/2016-07-01/namespaces/WcfRelays.md deleted file mode 100644 index 41f3087..0000000 --- a/test/Resource/Expected/Relay/2016-07-01/namespaces/WcfRelays.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.Relay/namespaces/WcfRelays template reference -API Version: 2016-07-01 -## Template format - -To create a Microsoft.Relay/namespaces/WcfRelays resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/WcfRelays", - "apiVersion": "2016-07-01", - "properties": { - "relayType": "string", - "requiresClientAuthorization": "boolean", - "requiresTransportSecurity": "boolean", - "userMetadata": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/WcfRelays object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The relay name | -| type | enum | Yes | Microsoft.Relay/namespaces/WcfRelays | -| apiVersion | enum | Yes | 2016-07-01 | -| properties | object | Yes | Properties of WcfRelay - [WcfRelayProperties object](#WcfRelayProperties) | -| resources | array | No | [authorizationRules](./WcfRelays/authorizationRules.md) | - - - -### WcfRelayProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| relayType | enum | No | WCFRelay Type. - NetTcp or Http | -| requiresClientAuthorization | boolean | No | true if client authorization is needed for this relay; otherwise, false. | -| requiresTransportSecurity | boolean | No | true if transport security is needed for this relay; otherwise, false. | -| userMetadata | string | No | 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. | - diff --git a/test/Resource/Expected/Relay/2016-07-01/namespaces/WcfRelays/authorizationRules.md b/test/Resource/Expected/Relay/2016-07-01/namespaces/WcfRelays/authorizationRules.md deleted file mode 100644 index e8a9e23..0000000 --- a/test/Resource/Expected/Relay/2016-07-01/namespaces/WcfRelays/authorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.Relay/namespaces/WcfRelays/authorizationRules template reference -API Version: 2016-07-01 -## Template format - -To create a Microsoft.Relay/namespaces/WcfRelays/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/WcfRelays/authorizationRules", - "apiVersion": "2016-07-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/WcfRelays/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorizationRule name. | -| type | enum | Yes | Microsoft.Relay/namespaces/WcfRelays/authorizationRules | -| apiVersion | enum | Yes | 2016-07-01 | -| properties | object | Yes | Authorization Rule properties - [AuthorizationRuleProperties object](#AuthorizationRuleProperties) | - - - -### AuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/Relay/2017-04-01/namespaces.md b/test/Resource/Expected/Relay/2017-04-01/namespaces.md deleted file mode 100644 index 3dc5487..0000000 --- a/test/Resource/Expected/Relay/2017-04-01/namespaces.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Relay/namespaces template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.Relay/namespaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces", - "apiVersion": "2017-04-01", - "location": "string", - "tags": {}, - "sku": { - "name": "Standard", - "tier": "Standard" - }, - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The namespace name | -| type | enum | Yes | Microsoft.Relay/namespaces | -| apiVersion | enum | Yes | 2017-04-01 | -| location | string | Yes | Resource location. | -| tags | object | No | Resource tags. | -| sku | object | No | SKU of the namespace. - [Sku object](#Sku) | -| properties | object | Yes | Description of Relay namespace - [RelayNamespaceProperties object](#RelayNamespaceProperties) | -| resources | array | No | [wcfRelays](./namespaces/wcfRelays.md) [hybridConnections](./namespaces/hybridConnections.md) [authorizationRules](./namespaces/authorizationRules.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Name of this SKU. - Standard | -| tier | enum | No | The tier of this SKU. - Standard | - diff --git a/test/Resource/Expected/Relay/2017-04-01/namespaces/authorizationRules.md b/test/Resource/Expected/Relay/2017-04-01/namespaces/authorizationRules.md deleted file mode 100644 index 94618ab..0000000 --- a/test/Resource/Expected/Relay/2017-04-01/namespaces/authorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.Relay/namespaces/authorizationRules template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.Relay/namespaces/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/authorizationRules", - "apiVersion": "2017-04-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorization rule name. | -| type | enum | Yes | Microsoft.Relay/namespaces/authorizationRules | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Authorization rule properties. - [AuthorizationRuleProperties object](#AuthorizationRuleProperties) | - - - -### AuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/Relay/2017-04-01/namespaces/hybridConnections.md b/test/Resource/Expected/Relay/2017-04-01/namespaces/hybridConnections.md deleted file mode 100644 index 87d4259..0000000 --- a/test/Resource/Expected/Relay/2017-04-01/namespaces/hybridConnections.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Relay/namespaces/hybridConnections template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.Relay/namespaces/hybridConnections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/hybridConnections", - "apiVersion": "2017-04-01", - "properties": { - "requiresClientAuthorization": "boolean", - "userMetadata": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/hybridConnections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The hybrid connection name. | -| type | enum | Yes | Microsoft.Relay/namespaces/hybridConnections | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties of the HybridConnection. - [HybridConnectionProperties object](#HybridConnectionProperties) | -| resources | array | No | [authorizationRules](./hybridConnections/authorizationRules.md) | - - - -### HybridConnectionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| requiresClientAuthorization | boolean | No | Returns true if client authorization is needed for this hybrid connection; otherwise, false. | -| userMetadata | string | No | 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. | - diff --git a/test/Resource/Expected/Relay/2017-04-01/namespaces/hybridConnections/authorizationRules.md b/test/Resource/Expected/Relay/2017-04-01/namespaces/hybridConnections/authorizationRules.md deleted file mode 100644 index 87adc1b..0000000 --- a/test/Resource/Expected/Relay/2017-04-01/namespaces/hybridConnections/authorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.Relay/namespaces/hybridConnections/authorizationRules template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.Relay/namespaces/hybridConnections/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/hybridConnections/authorizationRules", - "apiVersion": "2017-04-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/hybridConnections/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorization rule name. | -| type | enum | Yes | Microsoft.Relay/namespaces/hybridConnections/authorizationRules | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Authorization rule properties. - [AuthorizationRuleProperties object](#AuthorizationRuleProperties) | - - - -### AuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/Relay/2017-04-01/namespaces/wcfRelays.md b/test/Resource/Expected/Relay/2017-04-01/namespaces/wcfRelays.md deleted file mode 100644 index 804393f..0000000 --- a/test/Resource/Expected/Relay/2017-04-01/namespaces/wcfRelays.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.Relay/namespaces/wcfRelays template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.Relay/namespaces/wcfRelays resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/wcfRelays", - "apiVersion": "2017-04-01", - "properties": { - "relayType": "string", - "requiresClientAuthorization": "boolean", - "requiresTransportSecurity": "boolean", - "userMetadata": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/wcfRelays object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The relay name. | -| type | enum | Yes | Microsoft.Relay/namespaces/wcfRelays | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties of the WCF relay. - [WcfRelayProperties object](#WcfRelayProperties) | -| resources | array | No | [authorizationRules](./wcfRelays/authorizationRules.md) | - - - -### WcfRelayProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| relayType | enum | No | WCF relay type. - NetTcp or Http | -| requiresClientAuthorization | boolean | No | Returns true if client authorization is needed for this relay; otherwise, false. | -| requiresTransportSecurity | boolean | No | Returns true if transport security is needed for this relay; otherwise, false. | -| userMetadata | string | No | 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. | - diff --git a/test/Resource/Expected/Relay/2017-04-01/namespaces/wcfRelays/authorizationRules.md b/test/Resource/Expected/Relay/2017-04-01/namespaces/wcfRelays/authorizationRules.md deleted file mode 100644 index b8c692c..0000000 --- a/test/Resource/Expected/Relay/2017-04-01/namespaces/wcfRelays/authorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.Relay/namespaces/wcfRelays/authorizationRules template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.Relay/namespaces/wcfRelays/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Relay/namespaces/wcfRelays/authorizationRules", - "apiVersion": "2017-04-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Relay/namespaces/wcfRelays/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorization rule name. | -| type | enum | Yes | Microsoft.Relay/namespaces/wcfRelays/authorizationRules | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Authorization rule properties. - [AuthorizationRuleProperties object](#AuthorizationRuleProperties) | - - - -### AuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces.md b/test/Resource/Expected/ServiceBus/2015-08-01/namespaces.md deleted file mode 100644 index a6a273b..0000000 --- a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces.md +++ /dev/null @@ -1,61 +0,0 @@ -# Microsoft.ServiceBus/namespaces template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces", - "apiVersion": "2015-08-01", - "location": "string", - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "tags": {}, - "properties": { - "status": "string", - "createACSNamespace": "boolean", - "enabled": "boolean" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.ServiceBus/namespaces | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | Yes | Namespace location. | -| sku | object | No | [Sku object](#Sku) | -| tags | object | No | Namespace tags. | -| properties | object | Yes | [NamespaceProperties object](#NamespaceProperties) | -| resources | array | No | [topics](./namespaces/topics.md) [queues](./namespaces/queues.md) [AuthorizationRules](./namespaces/AuthorizationRules.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | No | Name of this SKU. - Basic, Standard, Premium | -| tier | enum | Yes | The billing tier of this particular SKU. - Basic, Standard, Premium | -| capacity | integer | No | The specified messaging units for the tier. | - - - -### NamespaceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | enum | No | State of the namespace. - Unknown, Creating, Created, Activating, Enabling, Active, Disabling, Disabled, SoftDeleting, SoftDeleted, Removing, Removed, Failed | -| createACSNamespace | boolean | No | Indicates whether to create an ACS namespace. | -| enabled | boolean | No | Specifies whether this instance is enabled. | - diff --git a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/AuthorizationRules.md b/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/AuthorizationRules.md deleted file mode 100644 index 48b3141..0000000 --- a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/AuthorizationRules.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.ServiceBus/namespaces/AuthorizationRules template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/AuthorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/AuthorizationRules", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/AuthorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorizationrule name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/AuthorizationRules | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | No | data center location. | -| properties | object | Yes | [SharedAccessAuthorizationRuleProperties object](#SharedAccessAuthorizationRuleProperties) | - - - -### SharedAccessAuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/queues.md b/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/queues.md deleted file mode 100644 index ac1a5d7..0000000 --- a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/queues.md +++ /dev/null @@ -1,70 +0,0 @@ -# Microsoft.ServiceBus/namespaces/queues template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/queues resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/queues", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "lockDuration": "string", - "autoDeleteOnIdle": "string", - "entityAvailabilityStatus": "string", - "defaultMessageTimeToLive": "string", - "duplicateDetectionHistoryTimeWindow": "string", - "enableBatchedOperations": "boolean", - "deadLetteringOnMessageExpiration": "boolean", - "enableExpress": "boolean", - "enablePartitioning": "boolean", - "isAnonymousAccessible": "boolean", - "maxDeliveryCount": "integer", - "maxSizeInMegabytes": "integer", - "requiresDuplicateDetection": "boolean", - "requiresSession": "boolean", - "status": "string", - "supportOrdering": "boolean" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/queues object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The queue name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/queues | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | Yes | location of the resource. | -| properties | object | Yes | [QueueProperties object](#QueueProperties) | -| resources | array | No | [authorizationRules](./queues/authorizationRules.md) | - - - -### QueueProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lockDuration | string | No | The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. | -| autoDeleteOnIdle | string | No | the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. | -| entityAvailabilityStatus | enum | No | Entity availability status for the queue. - Available, Limited, Renaming, Restoring, Unknown | -| defaultMessageTimeToLive | string | No | The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. | -| duplicateDetectionHistoryTimeWindow | string | No | TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | -| enableBatchedOperations | boolean | No | A value that indicates whether server-side batched operations are enabled. | -| deadLetteringOnMessageExpiration | boolean | No | A value that indicates whether this queue has dead letter support when a message expires. | -| enableExpress | boolean | No | A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. | -| enablePartitioning | boolean | No | A value that indicates whether the queue is to be partitioned across multiple message brokers. | -| isAnonymousAccessible | boolean | No | A value that indicates whether the message is accessible anonymously. | -| maxDeliveryCount | integer | No | The maximum delivery count. A message is automatically deadlettered after this number of deliveries. | -| maxSizeInMegabytes | integer | No | The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. | -| requiresDuplicateDetection | boolean | No | A value indicating if this queue requires duplicate detection. | -| requiresSession | boolean | No | A value that indicates whether the queue supports the concept of sessions. | -| status | enum | No | Enumerates the possible values for the status of a messaging entity. - Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown | -| supportOrdering | boolean | No | A value that indicates whether the queue supports ordering. | - diff --git a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/queues/authorizationRules.md b/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/queues/authorizationRules.md deleted file mode 100644 index 31ac614..0000000 --- a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/queues/authorizationRules.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.ServiceBus/namespaces/queues/authorizationRules template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/queues/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/queues/authorizationRules", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/queues/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorizationrule name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/queues/authorizationRules | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | No | data center location. | -| properties | object | Yes | [SharedAccessAuthorizationRuleProperties object](#SharedAccessAuthorizationRuleProperties) | - - - -### SharedAccessAuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics.md b/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics.md deleted file mode 100644 index 8f5f002..0000000 --- a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics.md +++ /dev/null @@ -1,68 +0,0 @@ -# Microsoft.ServiceBus/namespaces/topics template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/topics resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/topics", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "autoDeleteOnIdle": "string", - "entityAvailabilityStatus": "string", - "defaultMessageTimeToLive": "string", - "duplicateDetectionHistoryTimeWindow": "string", - "enableBatchedOperations": "boolean", - "enableExpress": "boolean", - "enablePartitioning": "boolean", - "enableSubscriptionPartitioning": "boolean", - "filteringMessagesBeforePublishing": "boolean", - "isAnonymousAccessible": "boolean", - "isExpress": "boolean", - "maxSizeInMegabytes": "integer", - "requiresDuplicateDetection": "boolean", - "status": "string", - "supportOrdering": "boolean" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/topics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The topic name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/topics | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | Yes | Location of the resource. | -| properties | object | Yes | [TopicProperties object](#TopicProperties) | -| resources | array | No | [subscriptions](./topics/subscriptions.md) [authorizationRules](./topics/authorizationRules.md) | - - - -### TopicProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| autoDeleteOnIdle | string | No | TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | -| entityAvailabilityStatus | enum | No | Entity availability status for the topic. - Available, Limited, Renaming, Restoring, Unknown | -| defaultMessageTimeToLive | string | No | 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 | No | TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | -| enableBatchedOperations | boolean | No | Value that indicates whether server-side batched operations are enabled. | -| enableExpress | boolean | No | Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. | -| enablePartitioning | boolean | No | Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. | -| enableSubscriptionPartitioning | boolean | No | Value that indicates whether partitioning is enabled or disabled. NOTE: This property is unsupported, and may be deprecated. | -| filteringMessagesBeforePublishing | boolean | No | Whether messages should be filtered before publishing. | -| isAnonymousAccessible | boolean | No | Value that indicates whether the message is accessible anonymously. | -| isExpress | boolean | No | | -| maxSizeInMegabytes | integer | No | Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. | -| requiresDuplicateDetection | boolean | No | Value indicating if this topic requires duplicate detection. | -| status | enum | No | Enumerates the possible values for the status of a messaging entity. - Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown | -| supportOrdering | boolean | No | Value that indicates whether the topic supports ordering. | - diff --git a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics/authorizationRules.md b/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics/authorizationRules.md deleted file mode 100644 index 87351f8..0000000 --- a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics/authorizationRules.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.ServiceBus/namespaces/topics/authorizationRules template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/topics/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/topics/authorizationRules", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/topics/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorizationrule name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/topics/authorizationRules | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | No | data center location. | -| properties | object | Yes | [SharedAccessAuthorizationRuleProperties object](#SharedAccessAuthorizationRuleProperties) | - - - -### SharedAccessAuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics/subscriptions.md b/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics/subscriptions.md deleted file mode 100644 index 502b300..0000000 --- a/test/Resource/Expected/ServiceBus/2015-08-01/namespaces/topics/subscriptions.md +++ /dev/null @@ -1,58 +0,0 @@ -# Microsoft.ServiceBus/namespaces/topics/subscriptions template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/topics/subscriptions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/topics/subscriptions", - "apiVersion": "2015-08-01", - "location": "string", - "properties": { - "autoDeleteOnIdle": "string", - "defaultMessageTimeToLive": "string", - "deadLetteringOnFilterEvaluationExceptions": "boolean", - "deadLetteringOnMessageExpiration": "boolean", - "enableBatchedOperations": "boolean", - "entityAvailabilityStatus": "string", - "isReadOnly": "boolean", - "lockDuration": "string", - "maxDeliveryCount": "integer", - "requiresSession": "boolean", - "status": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/topics/subscriptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The subscription name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/topics/subscriptions | -| apiVersion | enum | Yes | 2015-08-01 | -| location | string | Yes | Subscription data center location. | -| properties | object | Yes | [SubscriptionProperties object](#SubscriptionProperties) | - - - -### SubscriptionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| autoDeleteOnIdle | string | No | TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | -| defaultMessageTimeToLive | string | No | 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. | -| deadLetteringOnFilterEvaluationExceptions | boolean | No | Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. | -| deadLetteringOnMessageExpiration | boolean | No | Value that indicates whether a subscription has dead letter support when a message expires. | -| enableBatchedOperations | boolean | No | Value that indicates whether server-side batched operations are enabled. | -| entityAvailabilityStatus | enum | No | Entity availability status for the topic. - Available, Limited, Renaming, Restoring, Unknown | -| isReadOnly | boolean | No | Value that indicates whether the entity description is read-only. | -| lockDuration | string | No | The lock duration time span for the subscription. | -| maxDeliveryCount | integer | No | Number of maximum deliveries. | -| requiresSession | boolean | No | Value indicating if a subscription supports the concept of sessions. | -| status | enum | No | Enumerates the possible values for the status of a messaging entity. - Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown | - diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces.md b/test/Resource/Expected/ServiceBus/2017-04-01/namespaces.md deleted file mode 100644 index 488e13d..0000000 --- a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces.md +++ /dev/null @@ -1,48 +0,0 @@ -# Microsoft.ServiceBus/namespaces template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces", - "apiVersion": "2017-04-01", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "tier": "string", - "capacity": "integer" - }, - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.ServiceBus/namespaces | -| apiVersion | enum | Yes | 2017-04-01 | -| location | string | Yes | The Geo-location where the resource lives | -| tags | object | No | Resource tags | -| sku | object | No | Porperties of Sku - [SBSku object](#SBSku) | -| properties | object | Yes | Properties of the namespace. - [SBNamespaceProperties object](#SBNamespaceProperties) | -| resources | array | No | [topics](./namespaces/topics.md) [queues](./namespaces/queues.md) [disasterRecoveryConfigs](./namespaces/disasterRecoveryConfigs.md) [AuthorizationRules](./namespaces/AuthorizationRules.md) | - - - -### SBSku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Name of this SKU. - Basic, Standard, Premium | -| tier | enum | No | The billing tier of this particular SKU. - Basic, Standard, Premium | -| capacity | integer | No | The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. | - diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/AuthorizationRules.md b/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/AuthorizationRules.md deleted file mode 100644 index d086ae6..0000000 --- a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/AuthorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.ServiceBus/namespaces/AuthorizationRules template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/AuthorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/AuthorizationRules", - "apiVersion": "2017-04-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/AuthorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorizationrule name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/AuthorizationRules | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | AuthorizationRule properties. - [SBAuthorizationRuleProperties object](#SBAuthorizationRuleProperties) | - - - -### SBAuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/disasterRecoveryConfigs.md b/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/disasterRecoveryConfigs.md deleted file mode 100644 index efb61ae..0000000 --- a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/disasterRecoveryConfigs.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs", - "apiVersion": "2017-04-01", - "properties": { - "partnerNamespace": "string", - "alternateName": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The Disaster Recovery configuration name | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties required to the Create Or Update Alias(Disaster Recovery configurations) - [ArmDisasterRecoveryProperties object](#ArmDisasterRecoveryProperties) | - - - -### ArmDisasterRecoveryProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| partnerNamespace | string | No | ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairning | -| alternateName | string | No | Primary/Secondary eventhub namespace name, which is part of GEO DR pairning | - diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/queues.md b/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/queues.md deleted file mode 100644 index 14f8627..0000000 --- a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/queues.md +++ /dev/null @@ -1,64 +0,0 @@ -# Microsoft.ServiceBus/namespaces/queues template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/queues resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/queues", - "apiVersion": "2017-04-01", - "properties": { - "lockDuration": "string", - "maxSizeInMegabytes": "integer", - "requiresDuplicateDetection": "boolean", - "requiresSession": "boolean", - "defaultMessageTimeToLive": "string", - "deadLetteringOnMessageExpiration": "boolean", - "duplicateDetectionHistoryTimeWindow": "string", - "maxDeliveryCount": "integer", - "status": "string", - "autoDeleteOnIdle": "string", - "enablePartitioning": "boolean", - "enableExpress": "boolean", - "forwardTo": "string", - "forwardDeadLetteredMessagesTo": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/queues object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The queue name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/queues | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Queue Properties - [SBQueueProperties object](#SBQueueProperties) | -| resources | array | No | [authorizationRules](./queues/authorizationRules.md) | - - - -### SBQueueProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lockDuration | string | No | ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. | -| maxSizeInMegabytes | integer | No | The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. | -| requiresDuplicateDetection | boolean | No | A value indicating if this queue requires duplicate detection. | -| requiresSession | boolean | No | A value that indicates whether the queue supports the concept of sessions. | -| defaultMessageTimeToLive | string | No | 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. | -| deadLetteringOnMessageExpiration | boolean | No | A value that indicates whether this queue has dead letter support when a message expires. | -| duplicateDetectionHistoryTimeWindow | string | No | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | -| maxDeliveryCount | integer | No | The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. | -| status | enum | No | Enumerates the possible values for the status of a messaging entity. - Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Unknown | -| autoDeleteOnIdle | string | No | ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. | -| enablePartitioning | boolean | No | A value that indicates whether the queue is to be partitioned across multiple message brokers. | -| enableExpress | boolean | No | A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. | -| forwardTo | string | No | Queue/Topic name to forward the messages | -| forwardDeadLetteredMessagesTo | string | No | Queue/Topic name to forward the Dead Letter message | - diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/queues/authorizationRules.md b/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/queues/authorizationRules.md deleted file mode 100644 index 6fd4749..0000000 --- a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/queues/authorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.ServiceBus/namespaces/queues/authorizationRules template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/queues/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/queues/authorizationRules", - "apiVersion": "2017-04-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/queues/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorizationrule name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/queues/authorizationRules | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | AuthorizationRule properties. - [SBAuthorizationRuleProperties object](#SBAuthorizationRuleProperties) | - - - -### SBAuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics.md b/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics.md deleted file mode 100644 index 6af1326..0000000 --- a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics.md +++ /dev/null @@ -1,56 +0,0 @@ -# Microsoft.ServiceBus/namespaces/topics template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/topics resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/topics", - "apiVersion": "2017-04-01", - "properties": { - "defaultMessageTimeToLive": "string", - "maxSizeInMegabytes": "integer", - "requiresDuplicateDetection": "boolean", - "duplicateDetectionHistoryTimeWindow": "string", - "enableBatchedOperations": "boolean", - "status": "string", - "supportOrdering": "boolean", - "autoDeleteOnIdle": "string", - "enablePartitioning": "boolean", - "enableExpress": "boolean" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/topics object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The topic name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/topics | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties of topic resource. - [SBTopicProperties object](#SBTopicProperties) | -| resources | array | No | [subscriptions](./topics/subscriptions.md) [authorizationRules](./topics/authorizationRules.md) | - - - -### SBTopicProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| defaultMessageTimeToLive | string | No | 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. | -| maxSizeInMegabytes | integer | No | Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. | -| requiresDuplicateDetection | boolean | No | Value indicating if this topic requires duplicate detection. | -| duplicateDetectionHistoryTimeWindow | string | No | ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | -| enableBatchedOperations | boolean | No | Value that indicates whether server-side batched operations are enabled. | -| status | enum | No | Enumerates the possible values for the status of a messaging entity. - Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Unknown | -| supportOrdering | boolean | No | Value that indicates whether the topic supports ordering. | -| autoDeleteOnIdle | string | No | ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | -| enablePartitioning | boolean | No | Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. | -| enableExpress | boolean | No | Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. | - diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/authorizationRules.md b/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/authorizationRules.md deleted file mode 100644 index 9b4b6e4..0000000 --- a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/authorizationRules.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.ServiceBus/namespaces/topics/authorizationRules template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/topics/authorizationRules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/topics/authorizationRules", - "apiVersion": "2017-04-01", - "properties": { - "rights": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/topics/authorizationRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The authorizationrule name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/topics/authorizationRules | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | AuthorizationRule properties. - [SBAuthorizationRuleProperties object](#SBAuthorizationRuleProperties) | - - - -### SBAuthorizationRuleProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rights | array | Yes | The rights associated with the rule. - Manage, Send, Listen | - diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/subscriptions.md b/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/subscriptions.md deleted file mode 100644 index dc4d4ca..0000000 --- a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/subscriptions.md +++ /dev/null @@ -1,58 +0,0 @@ -# Microsoft.ServiceBus/namespaces/topics/subscriptions template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/topics/subscriptions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/topics/subscriptions", - "apiVersion": "2017-04-01", - "properties": { - "lockDuration": "string", - "requiresSession": "boolean", - "defaultMessageTimeToLive": "string", - "deadLetteringOnMessageExpiration": "boolean", - "duplicateDetectionHistoryTimeWindow": "string", - "maxDeliveryCount": "integer", - "status": "string", - "enableBatchedOperations": "boolean", - "autoDeleteOnIdle": "string", - "forwardTo": "string", - "forwardDeadLetteredMessagesTo": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/topics/subscriptions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The subscription name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/topics/subscriptions | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties of subscriptions resource. - [SBSubscriptionProperties object](#SBSubscriptionProperties) | -| resources | array | No | [rules](./subscriptions/rules.md) | - - - -### SBSubscriptionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| lockDuration | string | No | ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. | -| requiresSession | boolean | No | Value indicating if a subscription supports the concept of sessions. | -| defaultMessageTimeToLive | string | No | ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. | -| deadLetteringOnMessageExpiration | boolean | No | Value that indicates whether a subscription has dead letter support when a message expires. | -| duplicateDetectionHistoryTimeWindow | string | No | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | -| maxDeliveryCount | integer | No | Number of maximum deliveries. | -| status | enum | No | Enumerates the possible values for the status of a messaging entity. - Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Unknown | -| enableBatchedOperations | boolean | No | Value that indicates whether server-side batched operations are enabled. | -| autoDeleteOnIdle | string | No | ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | -| forwardTo | string | No | Queue/Topic name to forward the messages | -| forwardDeadLetteredMessagesTo | string | No | Queue/Topic name to forward the Dead Letter message | - diff --git a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/subscriptions/rules.md b/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/subscriptions/rules.md deleted file mode 100644 index 780b45c..0000000 --- a/test/Resource/Expected/ServiceBus/2017-04-01/namespaces/topics/subscriptions/rules.md +++ /dev/null @@ -1,91 +0,0 @@ -# Microsoft.ServiceBus/namespaces/topics/subscriptions/rules template reference -API Version: 2017-04-01 -## Template format - -To create a Microsoft.ServiceBus/namespaces/topics/subscriptions/rules resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules", - "apiVersion": "2017-04-01", - "properties": { - "action": { - "sqlExpression": "string", - "compatibilityLevel": "integer", - "requiresPreprocessing": "boolean" - }, - "filterType": "string", - "sqlFilter": { - "sqlExpression": "string", - "requiresPreprocessing": "boolean" - }, - "correlationFilter": { - "correlationId": "string", - "messageId": "string", - "to": "string", - "replyTo": "string", - "label": "string", - "sessionId": "string", - "replyToSessionId": "string", - "contentType": "string", - "requiresPreprocessing": "boolean" - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceBus/namespaces/topics/subscriptions/rules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The rule name. | -| type | enum | Yes | Microsoft.ServiceBus/namespaces/topics/subscriptions/rules | -| apiVersion | enum | Yes | 2017-04-01 | -| properties | object | Yes | Properties of Rule resource - [Ruleproperties object](#Ruleproperties) | - - - -### Ruleproperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| action | object | No | Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. - [Action object](#Action) | -| filterType | enum | No | Filter type that is evaluated against a BrokeredMessage. - SqlFilter or CorrelationFilter | -| sqlFilter | object | No | Properties of sqlFilter - [SqlFilter object](#SqlFilter) | -| correlationFilter | object | No | Properties of correlationFilter - [CorrelationFilter object](#CorrelationFilter) | - - - -### Action object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sqlExpression | string | No | SQL expression. e.g. MyProperty='ABC' | -| compatibilityLevel | integer | No | This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. | -| requiresPreprocessing | boolean | No | Value that indicates whether the rule action requires preprocessing. | - - - -### SqlFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sqlExpression | string | No | The SQL expression. e.g. MyProperty='ABC' | -| requiresPreprocessing | boolean | No | Value that indicates whether the rule action requires preprocessing. | - - - -### CorrelationFilter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| correlationId | string | No | Identifier of the correlation. | -| messageId | string | No | Identifier of the message. | -| to | string | No | Address to send to. | -| replyTo | string | No | Address of the queue to reply to. | -| label | string | No | Application specific label. | -| sessionId | string | No | Session identifier. | -| replyToSessionId | string | No | Session identifier to reply to. | -| contentType | string | No | Content type of the message. | -| requiresPreprocessing | boolean | No | Value that indicates whether the rule action requires preprocessing. | - diff --git a/test/Resource/Expected/ServiceFabric/2016-09-01/clusters.md b/test/Resource/Expected/ServiceFabric/2016-09-01/clusters.md deleted file mode 100644 index 49b97e0..0000000 --- a/test/Resource/Expected/ServiceFabric/2016-09-01/clusters.md +++ /dev/null @@ -1,263 +0,0 @@ -# Microsoft.ServiceFabric/clusters template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.ServiceFabric/clusters resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceFabric/clusters", - "apiVersion": "2016-09-01", - "location": "string", - "tags": {}, - "properties": { - "clusterCodeVersion": "string", - "certificate": { - "thumbprint": "string", - "thumbprintSecondary": "string", - "x509StoreName": "string" - }, - "reliabilityLevel": "string", - "upgradeMode": "string", - "clientCertificateThumbprints": [ - { - "isAdmin": "boolean", - "certificateThumbprint": "string" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": "boolean", - "certificateCommonName": "string", - "certificateIssuerThumbprint": "string" - } - ], - "fabricSettings": [ - { - "name": "string", - "parameters": [ - { - "name": "string", - "value": "string" - } - ] - } - ], - "reverseProxyCertificate": { - "thumbprint": "string", - "thumbprintSecondary": "string", - "x509StoreName": "string" - }, - "managementEndpoint": "string", - "nodeTypes": [ - { - "name": "string", - "placementProperties": {}, - "capacities": {}, - "clientConnectionEndpointPort": "integer", - "httpGatewayEndpointPort": "integer", - "durabilityLevel": "string", - "applicationPorts": { - "startPort": "integer", - "endPort": "integer" - }, - "ephemeralPorts": { - "startPort": "integer", - "endPort": "integer" - }, - "isPrimary": "boolean", - "vmInstanceCount": "integer", - "reverseProxyEndpointPort": "integer" - } - ], - "azureActiveDirectory": { - "tenantId": "string", - "clusterApplication": "string", - "clientApplication": "string" - }, - "vmImage": "string", - "diagnosticsStorageAccountConfig": { - "storageAccountName": "string", - "protectedAccountKeyName": "string", - "blobEndpoint": "string", - "queueEndpoint": "string", - "tableEndpoint": "string" - }, - "upgradeDescription": { - "overrideUserUpgradePolicy": "boolean", - "forceRestart": "boolean", - "upgradeReplicaSetCheckTimeout": "string", - "healthCheckWaitDuration": "string", - "healthCheckStableDuration": "string", - "healthCheckRetryTimeout": "string", - "upgradeTimeout": "string", - "upgradeDomainTimeout": "string", - "healthPolicy": { - "maxPercentUnhealthyNodes": "integer", - "maxPercentUnhealthyApplications": "integer" - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": "integer", - "maxPercentUpgradeDomainDeltaUnhealthyNodes": "integer", - "maxPercentDeltaUnhealthyApplications": "integer" - } - } - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceFabric/clusters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the cluster resource | -| type | enum | Yes | Microsoft.ServiceFabric/clusters | -| apiVersion | enum | Yes | 2016-09-01 | -| location | string | Yes | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | [ClusterProperties object](#ClusterProperties) | - - - -### ClusterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| clusterCodeVersion | string | No | The ServiceFabric code version running in your cluster | -| certificate | object | No | This primay certificate will be used as cluster node to node security, SSL certificate for cluster management endpoint and default admin client - [CertificateDescription object](#CertificateDescription) | -| reliabilityLevel | enum | No | Cluster reliability level indicates replica set size of system service. - Bronze, Silver, Gold, Platinum | -| upgradeMode | enum | No | Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not. - Automatic or Manual | -| clientCertificateThumbprints | array | No | The client thumbprint details ,it is used for client access for cluster operation - [ClientCertificateThumbprint object](#ClientCertificateThumbprint) | -| clientCertificateCommonNames | array | No | List of client certificates to whitelist based on common names - [ClientCertificateCommonName object](#ClientCertificateCommonName) | -| fabricSettings | array | No | List of custom fabric settings to configure the cluster. - [SettingsSectionDescription object](#SettingsSectionDescription) | -| reverseProxyCertificate | object | No | The server certificate used by reverse proxy - [CertificateDescription object](#CertificateDescription) | -| managementEndpoint | string | Yes | The http management endpoint of the cluster | -| nodeTypes | array | Yes | The list of nodetypes that make up the cluster - [NodeTypeDescription object](#NodeTypeDescription) | -| azureActiveDirectory | object | No | The settings to enable AAD authentication on the cluster - [AzureActiveDirectory object](#AzureActiveDirectory) | -| vmImage | string | No | The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. | -| diagnosticsStorageAccountConfig | object | No | The storage diagnostics account configuration details - [DiagnosticsStorageAccountConfig object](#DiagnosticsStorageAccountConfig) | -| upgradeDescription | object | No | The policy to use when upgrading the cluster. - [ClusterUpgradePolicy object](#ClusterUpgradePolicy) | - - - -### CertificateDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | Yes | Thumbprint of the primary certificate | -| thumbprintSecondary | string | No | Thumbprint of the secondary certificate | -| x509StoreName | enum | No | The local certificate store location. - AddressBook, AuthRoot, CertificateAuthority, Disallowed, My, Root, TrustedPeople, TrustedPublisher | - - - -### ClientCertificateThumbprint object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| isAdmin | boolean | Yes | Is this certificate used for admin access from the client, if false, it is used or query only access | -| certificateThumbprint | string | Yes | Certificate thumbprint | - - - -### ClientCertificateCommonName object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| isAdmin | boolean | Yes | Is this certificate used for admin access from the client, if false , it is used or query only access | -| certificateCommonName | string | Yes | Certificate common name to be granted access; be carefull using wild card common names | -| certificateIssuerThumbprint | string | Yes | Certificate issuer thumbprint | - - - -### SettingsSectionDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of settings section | -| parameters | array | Yes | Collection of settings in the section, each setting is a tuple consisting of setting name and value - [SettingsParameterDescription object](#SettingsParameterDescription) | - - - -### NodeTypeDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Name of the node type | -| placementProperties | object | No | The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run | -| capacities | object | No | The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much of a resource a node has | -| clientConnectionEndpointPort | integer | Yes | The TCP cluster management endpoint port | -| httpGatewayEndpointPort | integer | Yes | The HTTP cluster management endpoint port | -| durabilityLevel | enum | No | Nodetype durability Level. - Bronze, Silver, Gold | -| applicationPorts | object | No | Ports used by applications - [EndpointRangeDescription object](#EndpointRangeDescription) | -| ephemeralPorts | object | No | System assgined application ports - [EndpointRangeDescription object](#EndpointRangeDescription) | -| isPrimary | boolean | Yes | Mark this as the primary node type | -| vmInstanceCount | integer | Yes | The number of node instances in the node type | -| reverseProxyEndpointPort | integer | No | Endpoint used by reverse proxy | - - - -### AzureActiveDirectory object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| tenantId | string | No | Azure active directory tenant id | -| clusterApplication | string | No | Azure active directory cluster application id | -| clientApplication | string | No | Azure active directory client application id | - - - -### DiagnosticsStorageAccountConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountName | string | Yes | Diagnostics storage account name | -| protectedAccountKeyName | string | Yes | Protected Diagnostics storage key name | -| blobEndpoint | string | Yes | Diagnostics storage account blob endpoint | -| queueEndpoint | string | Yes | Diagnostics storage account queue endpoint | -| tableEndpoint | string | Yes | Diagnostics storage account table endpoint | - - - -### ClusterUpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| overrideUserUpgradePolicy | boolean | No | Use the user defined upgrade policy or not | -| forceRestart | boolean | No | Force node to restart or not | -| upgradeReplicaSetCheckTimeout | string | Yes | Timeout for replica set upgrade to complete,it represents .Net TimeSpan | -| healthCheckWaitDuration | string | Yes | The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan | -| healthCheckStableDuration | string | Yes | The length of time that health checks must pass continuously,it represents .Net TimeSpan | -| healthCheckRetryTimeout | string | Yes | The length of time that health checks can fail continuously,it represents .Net TimeSpan | -| upgradeTimeout | string | Yes | The upgrade timeout,it represents .Net TimeSpan | -| upgradeDomainTimeout | string | Yes | The timeout for any upgrade domain,it represents .Net TimeSpan | -| healthPolicy | object | Yes | Cluster health Policy - [ClusterHealthPolicy object](#ClusterHealthPolicy) | -| deltaHealthPolicy | object | No | Delta health policy - [ClusterUpgradeDeltaHealthPolicy object](#ClusterUpgradeDeltaHealthPolicy) | - - - -### SettingsParameterDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of settings property | -| value | string | Yes | The value of the property | - - - -### EndpointRangeDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| startPort | integer | Yes | Starting port of a range of ports | -| endPort | integer | Yes | End port of a range of ports | - - - -### ClusterHealthPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maxPercentUnhealthyNodes | integer | No | 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. | -| maxPercentUnhealthyApplications | integer | No | 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. | - - - -### ClusterUpgradeDeltaHealthPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maxPercentDeltaUnhealthyNodes | integer | Yes | Additional unhealthy nodes percentage | -| maxPercentUpgradeDomainDeltaUnhealthyNodes | integer | Yes | Additional unhealthy nodes percentage per upgrade domain | -| maxPercentDeltaUnhealthyApplications | integer | Yes | Additional unhealthy applications percentage | - diff --git a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters.md b/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters.md deleted file mode 100644 index 8c59992..0000000 --- a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters.md +++ /dev/null @@ -1,286 +0,0 @@ -# Microsoft.ServiceFabric/clusters template reference -API Version: 2017-07-01-preview -## Template format - -To create a Microsoft.ServiceFabric/clusters resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceFabric/clusters", - "apiVersion": "2017-07-01-preview", - "location": "string", - "tags": {}, - "properties": { - "availableClusterVersions": [ - { - "codeVersion": "string", - "supportExpiryUtc": "string", - "environment": "string" - } - ], - "clusterState": "string", - "clusterCodeVersion": "string", - "certificate": { - "thumbprint": "string", - "thumbprintSecondary": "string", - "x509StoreName": "string" - }, - "reliabilityLevel": "string", - "upgradeMode": "string", - "clientCertificateThumbprints": [ - { - "isAdmin": "boolean", - "certificateThumbprint": "string" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": "boolean", - "certificateCommonName": "string", - "certificateIssuerThumbprint": "string" - } - ], - "fabricSettings": [ - { - "name": "string", - "parameters": [ - { - "name": "string", - "value": "string" - } - ] - } - ], - "reverseProxyCertificate": { - "thumbprint": "string", - "thumbprintSecondary": "string", - "x509StoreName": "string" - }, - "managementEndpoint": "string", - "nodeTypes": [ - { - "name": "string", - "placementProperties": {}, - "capacities": {}, - "clientConnectionEndpointPort": "integer", - "httpGatewayEndpointPort": "integer", - "durabilityLevel": "string", - "applicationPorts": { - "startPort": "integer", - "endPort": "integer" - }, - "ephemeralPorts": { - "startPort": "integer", - "endPort": "integer" - }, - "isPrimary": "boolean", - "vmInstanceCount": "integer", - "reverseProxyEndpointPort": "integer" - } - ], - "azureActiveDirectory": { - "tenantId": "string", - "clusterApplication": "string", - "clientApplication": "string" - }, - "vmImage": "string", - "diagnosticsStorageAccountConfig": { - "storageAccountName": "string", - "protectedAccountKeyName": "string", - "blobEndpoint": "string", - "queueEndpoint": "string", - "tableEndpoint": "string" - }, - "upgradeDescription": { - "forceRestart": "boolean", - "upgradeReplicaSetCheckTimeout": "string", - "healthCheckWaitDuration": "string", - "healthCheckStableDuration": "string", - "healthCheckRetryTimeout": "string", - "upgradeTimeout": "string", - "upgradeDomainTimeout": "string", - "healthPolicy": { - "maxPercentUnhealthyNodes": "integer", - "maxPercentUnhealthyApplications": "integer" - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": "integer", - "maxPercentUpgradeDomainDeltaUnhealthyNodes": "integer", - "maxPercentDeltaUnhealthyApplications": "integer" - } - }, - "addOnFeatures": [ - "string" - ] - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceFabric/clusters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the cluster resource | -| type | enum | Yes | Microsoft.ServiceFabric/clusters | -| apiVersion | enum | Yes | 2017-07-01-preview | -| location | string | Yes | Resource location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | The cluster resource properties - [ClusterProperties object](#ClusterProperties) | -| resources | array | No | [applications](./clusters/applications.md) [applicationTypes](./clusters/applicationTypes.md) | - - - -### ClusterProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| availableClusterVersions | array | No | The Service Fabric runtime versions available for this cluster. - [ClusterVersionDetails object](#ClusterVersionDetails) | -| clusterState | enum | No | WaitingForNodes, Deploying, BaselineUpgrade, UpdatingUserConfiguration, UpdatingUserCertificate, UpdatingInfrastructure, EnforcingClusterVersion, UpgradeServiceUnreachable, AutoScale, Ready | -| clusterCodeVersion | string | No | 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**. | -| certificate | object | No | The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. - [CertificateDescription object](#CertificateDescription) | -| reliabilityLevel | enum | No | None, Bronze, Silver, Gold, Platinum | -| upgradeMode | enum | No | Automatic or Manual | -| clientCertificateThumbprints | array | No | The list of client certificates referenced by thumbprint that are allowed to manage the cluster. - [ClientCertificateThumbprint object](#ClientCertificateThumbprint) | -| clientCertificateCommonNames | array | No | The list of client certificates referenced by common name that are allowed to manage the cluster. - [ClientCertificateCommonName object](#ClientCertificateCommonName) | -| fabricSettings | array | No | The list of custom fabric settings to configure the cluster. - [SettingsSectionDescription object](#SettingsSectionDescription) | -| reverseProxyCertificate | object | No | The server certificate used by reverse proxy. - [CertificateDescription object](#CertificateDescription) | -| managementEndpoint | string | Yes | The http management endpoint of the cluster. | -| nodeTypes | array | Yes | The list of node types in the cluster. - [NodeTypeDescription object](#NodeTypeDescription) | -| azureActiveDirectory | object | No | The AAD authentication settings of the cluster. - [AzureActiveDirectory object](#AzureActiveDirectory) | -| vmImage | string | No | The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. | -| diagnosticsStorageAccountConfig | object | No | The storage account information for storing Service Fabric diagnostic logs. - [DiagnosticsStorageAccountConfig object](#DiagnosticsStorageAccountConfig) | -| upgradeDescription | object | No | The policy to use when upgrading the cluster. - [ClusterUpgradePolicy object](#ClusterUpgradePolicy) | -| addOnFeatures | array | No | The list of add-on features to enable in the cluster. - RepairManager, DnsService, BackupRestoreService | - - - -### ClusterVersionDetails object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| codeVersion | string | No | The Service Fabric runtime version of the cluster. | -| supportExpiryUtc | string | No | The date of expiry of support of the version. | -| environment | enum | No | Indicates if this version is for Windows or Linux operating system. - Windows or Linux | - - - -### CertificateDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| thumbprint | string | Yes | Thumbprint of the primary certificate. | -| thumbprintSecondary | string | No | Thumbprint of the secondary certificate. | -| x509StoreName | enum | No | The local certificate store location. - AddressBook, AuthRoot, CertificateAuthority, Disallowed, My, Root, TrustedPeople, TrustedPublisher | - - - -### ClientCertificateThumbprint object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| isAdmin | boolean | Yes | Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. | -| certificateThumbprint | string | Yes | The thumbprint of the client certificate. | - - - -### ClientCertificateCommonName object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| isAdmin | boolean | Yes | Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. | -| certificateCommonName | string | Yes | The common name of the client certificate. | -| certificateIssuerThumbprint | string | Yes | The issuer thumbprint of the client certificate. | - - - -### SettingsSectionDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The section name of the fabric settings. | -| parameters | array | Yes | The collection of parameters in the section. - [SettingsParameterDescription object](#SettingsParameterDescription) | - - - -### NodeTypeDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the node type. | -| placementProperties | object | No | The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. | -| capacities | object | No | 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 | integer | Yes | The TCP cluster management endpoint port. | -| httpGatewayEndpointPort | integer | Yes | The HTTP cluster management endpoint port. | -| durabilityLevel | enum | No | Bronze, Silver, Gold | -| applicationPorts | object | No | The range of ports from which cluster assigned port to Service Fabric applications. - [EndpointRangeDescription object](#EndpointRangeDescription) | -| ephemeralPorts | object | No | The range of empheral ports that nodes in this node type should be configured with. - [EndpointRangeDescription object](#EndpointRangeDescription) | -| isPrimary | boolean | Yes | 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. | -| vmInstanceCount | integer | Yes | The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. | -| reverseProxyEndpointPort | integer | No | The endpoint used by reverse proxy. | - - - -### AzureActiveDirectory object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| tenantId | string | No | Azure active directory tenant id. | -| clusterApplication | string | No | Azure active directory cluster application id. | -| clientApplication | string | No | Azure active directory client application id. | - - - -### DiagnosticsStorageAccountConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| storageAccountName | string | Yes | The Azure storage account name. | -| protectedAccountKeyName | string | Yes | The protected diagnostics storage key name. | -| blobEndpoint | string | Yes | The blob endpoint of the azure storage account. | -| queueEndpoint | string | Yes | The queue endpoint of the azure storage account. | -| tableEndpoint | string | Yes | The table endpoint of the azure storage account. | - - - -### ClusterUpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| forceRestart | boolean | No | If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). | -| upgradeReplicaSetCheckTimeout | string | Yes | The maximum amount of time to block processing of an upgrade domain and revent 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. | -| healthCheckWaitDuration | string | Yes | 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. | -| healthCheckStableDuration | string | Yes | 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. | -| healthCheckRetryTimeout | string | Yes | 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. | -| upgradeTimeout | string | Yes | 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. | -| upgradeDomainTimeout | string | Yes | 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. | -| healthPolicy | object | Yes | The cluster health policy used when upgrading the cluster. - [ClusterHealthPolicy object](#ClusterHealthPolicy) | -| deltaHealthPolicy | object | No | The delta health policy used when upgrading the cluster. - [ClusterUpgradeDeltaHealthPolicy object](#ClusterUpgradeDeltaHealthPolicy) | - - - -### SettingsParameterDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The parameter name of fabric setting. | -| value | string | Yes | The parameter value of fabric setting. | - - - -### EndpointRangeDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| startPort | integer | Yes | Starting port of a range of ports | -| endPort | integer | Yes | End port of a range of ports | - - - -### ClusterHealthPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maxPercentUnhealthyNodes | integer | No | 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. | -| maxPercentUnhealthyApplications | integer | No | 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. | - - - -### ClusterUpgradeDeltaHealthPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maxPercentDeltaUnhealthyNodes | integer | Yes | 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 | integer | Yes | 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. | -| maxPercentDeltaUnhealthyApplications | integer | Yes | 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. | - diff --git a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applicationTypes.md b/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applicationTypes.md deleted file mode 100644 index 6804885..0000000 --- a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applicationTypes.md +++ /dev/null @@ -1,31 +0,0 @@ -# Microsoft.ServiceFabric/clusters/applicationTypes template reference -API Version: 2017-07-01-preview -## Template format - -To create a Microsoft.ServiceFabric/clusters/applicationTypes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceFabric/clusters/applicationTypes", - "apiVersion": "2017-07-01-preview", - "location": "string", - "properties": {}, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceFabric/clusters/applicationTypes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the application type name resource | -| type | enum | Yes | Microsoft.ServiceFabric/clusters/applicationTypes | -| apiVersion | enum | Yes | 2017-07-01-preview | -| location | string | Yes | Resource location. | -| properties | object | Yes | [ApplicationTypeProperties object](#ApplicationTypeProperties) | -| resources | array | No | [versions](./applicationTypes/versions.md) | - diff --git a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applicationTypes/versions.md b/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applicationTypes/versions.md deleted file mode 100644 index 72a6092..0000000 --- a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applicationTypes/versions.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.ServiceFabric/clusters/applicationTypes/versions template reference -API Version: 2017-07-01-preview -## Template format - -To create a Microsoft.ServiceFabric/clusters/applicationTypes/versions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceFabric/clusters/applicationTypes/versions", - "apiVersion": "2017-07-01-preview", - "location": "string", - "properties": { - "appPackageUrl": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceFabric/clusters/applicationTypes/versions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The application type version. | -| type | enum | Yes | Microsoft.ServiceFabric/clusters/applicationTypes/versions | -| apiVersion | enum | Yes | 2017-07-01-preview | -| location | string | Yes | Resource location. | -| properties | object | Yes | [VersionProperties object](#VersionProperties) | - - - -### VersionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| appPackageUrl | string | Yes | The URL to the application package | - diff --git a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applications.md b/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applications.md deleted file mode 100644 index da748dd..0000000 --- a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applications.md +++ /dev/null @@ -1,161 +0,0 @@ -# Microsoft.ServiceFabric/clusters/applications template reference -API Version: 2017-07-01-preview -## Template format - -To create a Microsoft.ServiceFabric/clusters/applications resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceFabric/clusters/applications", - "apiVersion": "2017-07-01-preview", - "location": "string", - "properties": { - "typeVersion": "string", - "parameters": [ - { - "Key": "string", - "Value": "string" - } - ], - "upgradePolicy": { - "upgradeReplicaSetCheckTimeout": "integer", - "forceRestart": "boolean", - "rollingUpgradeMonitoringPolicy": { - "healthCheckWaitDuration": "string", - "healthCheckStableDuration": "string", - "healthCheckRetryTimeout": "string", - "upgradeTimeout": "string", - "upgradeDomainTimeout": "string" - }, - "applicationHealthPolicy": { - "ConsiderWarningAsError": "boolean", - "MaxPercentUnhealthyDeployedApplications": "integer", - "DefaultServiceTypeHealthPolicy": { - "MaxPercentUnhealthyPartitionsPerService": "integer", - "MaxPercentUnhealthyReplicasPerPartition": "integer", - "MaxPercentUnhealthyServices": "integer" - }, - "ServiceTypeHealthPolicyMap": [ - { - "Key": "string", - "Value": { - "MaxPercentUnhealthyPartitionsPerService": "integer", - "MaxPercentUnhealthyReplicasPerPartition": "integer", - "MaxPercentUnhealthyServices": "integer" - } - } - ] - } - }, - "minimumNodes": "integer", - "maximumNodes": "integer", - "removeApplicationCapacity": "boolean", - "metrics": [ - { - "Name": "string", - "MaximumCapacity": "integer", - "ReservationCapacity": "integer", - "TotalApplicationCapacity": "integer" - } - ], - "typeName": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceFabric/clusters/applications object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the application resource. | -| type | enum | Yes | Microsoft.ServiceFabric/clusters/applications | -| apiVersion | enum | Yes | 2017-07-01-preview | -| location | string | Yes | Resource location. | -| properties | object | Yes | [ApplicationProperties object](#ApplicationProperties) | -| resources | array | No | [services](./applications/services.md) | - - - -### ApplicationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| typeVersion | string | No | | -| parameters | array | No | [ApplicationParameter object](#ApplicationParameter) | -| upgradePolicy | object | No | [ApplicationUpgradePolicy object](#ApplicationUpgradePolicy) | -| minimumNodes | integer | No | 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. | -| maximumNodes | integer | No | 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. | -| removeApplicationCapacity | boolean | No | The version of the application type | -| metrics | array | No | [ApplicationMetricDescription object](#ApplicationMetricDescription) | -| typeName | string | No | | - - - -### ApplicationParameter object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| Key | string | Yes | The name of the parameter. | -| Value | string | Yes | The value of the parameter. | - - - -### ApplicationUpgradePolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| upgradeReplicaSetCheckTimeout | integer | No | | -| forceRestart | boolean | No | | -| rollingUpgradeMonitoringPolicy | object | No | [RollingUpgradeMonitoringPolicy object](#RollingUpgradeMonitoringPolicy) | -| applicationHealthPolicy | object | No | [ApplicationHealthPolicy object](#ApplicationHealthPolicy) | - - - -### ApplicationMetricDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| Name | string | No | The name of the metric. | -| MaximumCapacity | integer | No | 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. | -| ReservationCapacity | integer | No | 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 | integer | No | 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. | - - - -### RollingUpgradeMonitoringPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| healthCheckWaitDuration | string | No | | -| healthCheckStableDuration | string | No | | -| healthCheckRetryTimeout | string | No | | -| upgradeTimeout | string | No | | -| upgradeDomainTimeout | string | No | | - - - -### ApplicationHealthPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ConsiderWarningAsError | boolean | No | Indicates whether warnings are treated with the same severity as errors. | -| MaxPercentUnhealthyDeployedApplications | integer | No | 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. | -| DefaultServiceTypeHealthPolicy | object | No | [ServiceTypeHealthPolicy object](#ServiceTypeHealthPolicy) | -| ServiceTypeHealthPolicyMap | array | No | [ServiceTypeHealthPolicyMapItem object](#ServiceTypeHealthPolicyMapItem) | - - - -### ServiceTypeHealthPolicy object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| MaxPercentUnhealthyPartitionsPerService | integer | No | The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100The 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. Default percentage is zero. | -| MaxPercentUnhealthyReplicasPerPartition | integer | No | The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.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. Default percentage is zero. | -| MaxPercentUnhealthyServices | integer | No | The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.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. Default percentage is zero. | - - - -### ServiceTypeHealthPolicyMapItem object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| Key | string | Yes | The key of the service type health policy map item. This is the name of the service type. | -| Value | object | Yes | [ServiceTypeHealthPolicy object](#ServiceTypeHealthPolicy) | - diff --git a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applications/services.md b/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applications/services.md deleted file mode 100644 index a488228..0000000 --- a/test/Resource/Expected/ServiceFabric/2017-07-01-preview/clusters/applications/services.md +++ /dev/null @@ -1,84 +0,0 @@ -# Microsoft.ServiceFabric/clusters/applications/services template reference -API Version: 2017-07-01-preview -## Template format - -To create a Microsoft.ServiceFabric/clusters/applications/services resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.ServiceFabric/clusters/applications/services", - "apiVersion": "2017-07-01-preview", - "location": "string", - "properties": { - "placementConstraints": "string", - "correlationScheme": [ - { - "Scheme": "string", - "ServiceName": "string" - } - ], - "serviceLoadMetrics": [ - { - "Name": "string", - "Weight": "string", - "PrimaryDefaultLoad": "integer", - "SecondaryDefaultLoad": "integer", - "DefaultLoad": "integer" - } - ], - "servicePlacementPolicies": [ - {} - ], - "defaultMoveCost": "string", - "serviceTypeName": "string", - "partitionDescription": {} - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.ServiceFabric/clusters/applications/services object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | The name of the service resource in the format of {applicationName}~{serviceName}. | -| type | enum | Yes | Microsoft.ServiceFabric/clusters/applications/services | -| apiVersion | enum | Yes | 2017-07-01-preview | -| location | string | Yes | Resource location. | -| properties | object | Yes | [ServiceProperties object](#ServiceProperties) | - - - -### ServiceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| placementConstraints | string | No | 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)". | -| correlationScheme | array | No | [ServiceCorrelationDescription object](#ServiceCorrelationDescription) | -| serviceLoadMetrics | array | No | [ServiceLoadMetricDescription object](#ServiceLoadMetricDescription) | -| servicePlacementPolicies | array | No | [ServicePlacementPolicyDescription object](#ServicePlacementPolicyDescription) | -| defaultMoveCost | enum | No | Zero, Low, Medium, High | -| serviceTypeName | string | No | The name of the service type | -| partitionDescription | object | No | [PartitionSchemeDescription object](#PartitionSchemeDescription) | - - - -### ServiceCorrelationDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| Scheme | enum | Yes | Invalid, Affinity, AlignedAffinity, NonAlignedAffinity | -| ServiceName | string | Yes | | - - - -### ServiceLoadMetricDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| Name | string | Yes | 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. | -| Weight | enum | No | Zero, Low, Medium, High | -| PrimaryDefaultLoad | integer | No | 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 | integer | No | 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. | -| DefaultLoad | integer | No | Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. | - diff --git a/test/Resource/Expected/Storage/2015-05-01-preview/Microsoft.Storage.json b/test/Resource/Expected/Storage/2015-05-01-preview/Microsoft.Storage.json deleted file mode 100644 index f0655ec..0000000 --- a/test/Resource/Expected/Storage/2015-05-01-preview/Microsoft.Storage.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-05-01-preview/Microsoft.Storage.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Storage", - "description": "Microsoft Storage Resource Types", - "resourceDefinitions": { - "storageAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Storage/storageAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-05-01-preview" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Storage/storageAccounts" - } - }, - "definitions": { - "StorageAccountPropertiesCreateParameters": { - "type": "object", - "properties": { - "accountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the account type." - } - } - } - } -} diff --git a/test/Resource/Expected/Storage/2015-05-01-preview/storageAccounts.md b/test/Resource/Expected/Storage/2015-05-01-preview/storageAccounts.md deleted file mode 100644 index daccd3d..0000000 --- a/test/Resource/Expected/Storage/2015-05-01-preview/storageAccounts.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Storage/storageAccounts template reference -API Version: 2015-05-01-preview -## Template format - -To create a Microsoft.Storage/storageAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Storage/storageAccounts", - "apiVersion": "2015-05-01-preview", - "location": "string", - "tags": {}, - "properties": { - "accountType": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Storage/storageAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Storage/storageAccounts | -| apiVersion | enum | Yes | 2015-05-01-preview | -| location | string | Yes | Resource location | -| tags | object | No | Resource tags | -| properties | object | Yes | [StorageAccountPropertiesCreateParameters object](#StorageAccountPropertiesCreateParameters) | - - - -### StorageAccountPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| accountType | enum | No | Gets or sets the account type. - Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS, Premium_LRS | - diff --git a/test/Resource/Expected/Storage/2015-06-15/Microsoft.Storage.json b/test/Resource/Expected/Storage/2015-06-15/Microsoft.Storage.json deleted file mode 100644 index 4ac81b1..0000000 --- a/test/Resource/Expected/Storage/2015-06-15/Microsoft.Storage.json +++ /dev/null @@ -1,94 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-06-15/Microsoft.Storage.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Storage", - "description": "Microsoft Storage Resource Types", - "resourceDefinitions": { - "storageAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Storage/storageAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-06-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Storage/storageAccounts" - } - }, - "definitions": { - "StorageAccountPropertiesCreateParameters": { - "type": "object", - "properties": { - "accountType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType." - } - }, - "required": [ - "accountType" - ], - "description": "The parameters used to create the storage account." - } - } -} diff --git a/test/Resource/Expected/Storage/2015-06-15/storageAccounts.md b/test/Resource/Expected/Storage/2015-06-15/storageAccounts.md deleted file mode 100644 index 8bcee12..0000000 --- a/test/Resource/Expected/Storage/2015-06-15/storageAccounts.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Storage/storageAccounts template reference -API Version: 2015-06-15 -## Template format - -To create a Microsoft.Storage/storageAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Storage/storageAccounts", - "apiVersion": "2015-06-15", - "location": "string", - "tags": {}, - "properties": { - "accountType": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Storage/storageAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Storage/storageAccounts | -| apiVersion | enum | Yes | 2015-06-15 | -| location | string | Yes | The location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. | -| tags | object | No | 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. | -| properties | object | Yes | [StorageAccountPropertiesCreateParameters object](#StorageAccountPropertiesCreateParameters) | - - - -### StorageAccountPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| accountType | enum | Yes | The sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. - Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS, Premium_LRS | - diff --git a/test/Resource/Expected/Storage/2016-01-01/Microsoft.Storage.json b/test/Resource/Expected/Storage/2016-01-01/Microsoft.Storage.json deleted file mode 100644 index 868e906..0000000 --- a/test/Resource/Expected/Storage/2016-01-01/Microsoft.Storage.json +++ /dev/null @@ -1,256 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-01-01/Microsoft.Storage.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Storage", - "description": "Microsoft Storage Resource Types", - "resourceDefinitions": { - "storageAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Storage/storageAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-01-01" - ] - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Gets or sets the sku name." - }, - "kind": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Storage", - "BlobStorage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Indicates the type of storage account." - }, - "location": { - "type": "string", - "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "sku", - "kind", - "location", - "properties" - ], - "description": "Microsoft.Storage/storageAccounts" - } - }, - "definitions": { - "CustomDomain": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." - }, - "useSubDomain": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." - } - }, - "required": [ - "name" - ], - "description": "The custom domain assigned to this storage account. This can be set via Update." - }, - "Encryption": { - "type": "object", - "properties": { - "services": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionServices" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of services which support encryption." - }, - "keySource": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft.Storage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage" - } - }, - "required": [ - "keySource" - ], - "description": "The encryption settings on the storage account." - }, - "EncryptionService": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A boolean indicating whether or not the service encrypts the data as it is stored." - } - }, - "description": "A service that allows server-side encryption to be used." - }, - "EncryptionServices": { - "type": "object", - "properties": { - "blob": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionService" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption function of the blob storage service." - } - }, - "description": "A list of services that support encryption." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_GRS", - "Standard_RAGRS", - "Standard_ZRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType." - } - }, - "required": [ - "name" - ], - "description": "The SKU of the storage account." - }, - "StorageAccountPropertiesCreateParameters": { - "type": "object", - "properties": { - "customDomain": { - "oneOf": [ - { - "$ref": "#/definitions/CustomDomain" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." - }, - "encryption": { - "oneOf": [ - { - "$ref": "#/definitions/Encryption" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted." - }, - "accessTier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Hot", - "Cool" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing." - } - } - } - } -} diff --git a/test/Resource/Expected/Storage/2016-01-01/storageAccounts.md b/test/Resource/Expected/Storage/2016-01-01/storageAccounts.md deleted file mode 100644 index fa36420..0000000 --- a/test/Resource/Expected/Storage/2016-01-01/storageAccounts.md +++ /dev/null @@ -1,97 +0,0 @@ -# Microsoft.Storage/storageAccounts template reference -API Version: 2016-01-01 -## Template format - -To create a Microsoft.Storage/storageAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Storage/storageAccounts", - "apiVersion": "2016-01-01", - "sku": { - "name": "string" - }, - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "customDomain": { - "name": "string", - "useSubDomain": "boolean" - }, - "encryption": { - "services": { - "blob": { - "enabled": "boolean" - } - }, - "keySource": "Microsoft.Storage" - }, - "accessTier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Storage/storageAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Storage/storageAccounts | -| apiVersion | enum | Yes | 2016-01-01 | -| sku | object | Yes | Required. Gets or sets the sku name. - [Sku object](#Sku) | -| kind | enum | Yes | Required. Indicates the type of storage account. - Storage or BlobStorage | -| location | string | Yes | Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. | -| tags | object | No | 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. | -| properties | object | Yes | [StorageAccountPropertiesCreateParameters object](#StorageAccountPropertiesCreateParameters) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. - Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS | - - - -### StorageAccountPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| customDomain | object | No | User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. - [CustomDomain object](#CustomDomain) | -| encryption | object | No | Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted. - [Encryption object](#Encryption) | -| accessTier | enum | No | Required for storage accounts where kind = BlobStorage. The access tier used for billing. - Hot or Cool | - - - -### CustomDomain object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. | -| useSubDomain | boolean | No | Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. | - - - -### Encryption object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| services | object | No | List of services which support encryption. - [EncryptionServices object](#EncryptionServices) | -| keySource | enum | Yes | The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage - Microsoft.Storage | - - - -### EncryptionServices object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| blob | object | No | The encryption function of the blob storage service. - [EncryptionService object](#EncryptionService) | - - - -### EncryptionService object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | A boolean indicating whether or not the service encrypts the data as it is stored. | - diff --git a/test/Resource/Expected/Storage/2016-05-01/Microsoft.Storage.json b/test/Resource/Expected/Storage/2016-05-01/Microsoft.Storage.json deleted file mode 100644 index c0187b5..0000000 --- a/test/Resource/Expected/Storage/2016-05-01/Microsoft.Storage.json +++ /dev/null @@ -1,257 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-05-01/Microsoft.Storage.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Storage", - "description": "Microsoft Storage Resource Types", - "resourceDefinitions": { - "storageAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Storage/storageAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-05-01" - ] - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Gets or sets the sku name." - }, - "kind": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Storage", - "BlobStorage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Indicates the type of storage account." - }, - "location": { - "type": "string", - "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "sku", - "kind", - "location", - "properties" - ], - "description": "Microsoft.Storage/storageAccounts" - } - }, - "definitions": { - "CustomDomain": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." - }, - "useSubDomain": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." - } - }, - "required": [ - "name" - ], - "description": "The custom domain assigned to this storage account. This can be set via Update." - }, - "Encryption": { - "type": "object", - "properties": { - "services": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionServices" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of services which support encryption." - }, - "keySource": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft.Storage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage" - } - }, - "required": [ - "keySource" - ], - "description": "The encryption settings on the storage account." - }, - "EncryptionService": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A boolean indicating whether or not the service encrypts the data as it is stored." - } - }, - "description": "A service that allows server-side encryption to be used." - }, - "EncryptionServices": { - "type": "object", - "properties": { - "blob": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionService" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption function of the blob storage service." - } - }, - "description": "A list of services that support encryption." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_GRS", - "Standard_RAGRS", - "Standard_ZRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType." - } - }, - "required": [ - "name" - ], - "description": "The SKU of the storage account." - }, - "StorageAccountPropertiesCreateParameters": { - "type": "object", - "properties": { - "customDomain": { - "oneOf": [ - { - "$ref": "#/definitions/CustomDomain" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." - }, - "encryption": { - "oneOf": [ - { - "$ref": "#/definitions/Encryption" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted." - }, - "accessTier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Hot", - "Cool" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing." - } - }, - "description": "The parameters used to create the storage account." - } - } -} diff --git a/test/Resource/Expected/Storage/2016-05-01/storageAccounts.md b/test/Resource/Expected/Storage/2016-05-01/storageAccounts.md deleted file mode 100644 index 4112fd9..0000000 --- a/test/Resource/Expected/Storage/2016-05-01/storageAccounts.md +++ /dev/null @@ -1,97 +0,0 @@ -# Microsoft.Storage/storageAccounts template reference -API Version: 2016-05-01 -## Template format - -To create a Microsoft.Storage/storageAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Storage/storageAccounts", - "apiVersion": "2016-05-01", - "sku": { - "name": "string" - }, - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "customDomain": { - "name": "string", - "useSubDomain": "boolean" - }, - "encryption": { - "services": { - "blob": { - "enabled": "boolean" - } - }, - "keySource": "Microsoft.Storage" - }, - "accessTier": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Storage/storageAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Storage/storageAccounts | -| apiVersion | enum | Yes | 2016-05-01 | -| sku | object | Yes | Required. Gets or sets the sku name. - [Sku object](#Sku) | -| kind | enum | Yes | Required. Indicates the type of storage account. - Storage or BlobStorage | -| location | string | Yes | Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. | -| tags | object | No | 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. | -| properties | object | Yes | [StorageAccountPropertiesCreateParameters object](#StorageAccountPropertiesCreateParameters) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. - Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS | - - - -### StorageAccountPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| customDomain | object | No | User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. - [CustomDomain object](#CustomDomain) | -| encryption | object | No | Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted. - [Encryption object](#Encryption) | -| accessTier | enum | No | Required for storage accounts where kind = BlobStorage. The access tier used for billing. - Hot or Cool | - - - -### CustomDomain object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. | -| useSubDomain | boolean | No | Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. | - - - -### Encryption object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| services | object | No | List of services which support encryption. - [EncryptionServices object](#EncryptionServices) | -| keySource | enum | Yes | The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage - Microsoft.Storage | - - - -### EncryptionServices object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| blob | object | No | The encryption function of the blob storage service. - [EncryptionService object](#EncryptionService) | - - - -### EncryptionService object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | A boolean indicating whether or not the service encrypts the data as it is stored. | - diff --git a/test/Resource/Expected/Storage/2016-12-01/Microsoft.Storage.json b/test/Resource/Expected/Storage/2016-12-01/Microsoft.Storage.json deleted file mode 100644 index 002cc6b..0000000 --- a/test/Resource/Expected/Storage/2016-12-01/Microsoft.Storage.json +++ /dev/null @@ -1,280 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-12-01/Microsoft.Storage.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Storage", - "description": "Microsoft Storage Resource Types", - "resourceDefinitions": { - "storageAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Storage/storageAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-12-01" - ] - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Gets or sets the sku name." - }, - "kind": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Storage", - "BlobStorage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Indicates the type of storage account." - }, - "location": { - "type": "string", - "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "sku", - "kind", - "location", - "properties" - ], - "description": "Microsoft.Storage/storageAccounts" - } - }, - "definitions": { - "CustomDomain": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." - }, - "useSubDomain": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." - } - }, - "required": [ - "name" - ], - "description": "The custom domain assigned to this storage account. This can be set via Update." - }, - "Encryption": { - "type": "object", - "properties": { - "services": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionServices" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of services which support encryption." - }, - "keySource": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft.Storage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage" - } - }, - "required": [ - "keySource" - ], - "description": "The encryption settings on the storage account." - }, - "EncryptionService": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A boolean indicating whether or not the service encrypts the data as it is stored." - } - }, - "description": "A service that allows server-side encryption to be used." - }, - "EncryptionServices": { - "type": "object", - "properties": { - "blob": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionService" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption function of the blob storage service." - }, - "file": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionService" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption function of the file storage service." - } - }, - "description": "A list of services that support encryption." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_GRS", - "Standard_RAGRS", - "Standard_ZRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType." - } - }, - "required": [ - "name" - ], - "description": "The SKU of the storage account." - }, - "StorageAccountPropertiesCreateParameters": { - "type": "object", - "properties": { - "customDomain": { - "oneOf": [ - { - "$ref": "#/definitions/CustomDomain" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." - }, - "encryption": { - "oneOf": [ - { - "$ref": "#/definitions/Encryption" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted." - }, - "accessTier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Hot", - "Cool" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing." - }, - "supportsHttpsTrafficOnly": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allows https traffic only to storage service if sets to true." - } - }, - "description": "The parameters used to create the storage account." - } - } -} diff --git a/test/Resource/Expected/Storage/2016-12-01/storageAccounts.md b/test/Resource/Expected/Storage/2016-12-01/storageAccounts.md deleted file mode 100644 index 6901ae4..0000000 --- a/test/Resource/Expected/Storage/2016-12-01/storageAccounts.md +++ /dev/null @@ -1,103 +0,0 @@ -# Microsoft.Storage/storageAccounts template reference -API Version: 2016-12-01 -## Template format - -To create a Microsoft.Storage/storageAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Storage/storageAccounts", - "apiVersion": "2016-12-01", - "sku": { - "name": "string" - }, - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "customDomain": { - "name": "string", - "useSubDomain": "boolean" - }, - "encryption": { - "services": { - "blob": { - "enabled": "boolean" - }, - "file": { - "enabled": "boolean" - } - }, - "keySource": "Microsoft.Storage" - }, - "accessTier": "string", - "supportsHttpsTrafficOnly": "boolean" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Storage/storageAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Storage/storageAccounts | -| apiVersion | enum | Yes | 2016-12-01 | -| sku | object | Yes | Required. Gets or sets the sku name. - [Sku object](#Sku) | -| kind | enum | Yes | Required. Indicates the type of storage account. - Storage or BlobStorage | -| location | string | Yes | Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. | -| tags | object | No | 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. | -| properties | object | Yes | [StorageAccountPropertiesCreateParameters object](#StorageAccountPropertiesCreateParameters) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. - Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS | - - - -### StorageAccountPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| customDomain | object | No | User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. - [CustomDomain object](#CustomDomain) | -| encryption | object | No | Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted. - [Encryption object](#Encryption) | -| accessTier | enum | No | Required for storage accounts where kind = BlobStorage. The access tier used for billing. - Hot or Cool | -| supportsHttpsTrafficOnly | boolean | No | Allows https traffic only to storage service if sets to true. | - - - -### CustomDomain object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. | -| useSubDomain | boolean | No | Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. | - - - -### Encryption object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| services | object | No | List of services which support encryption. - [EncryptionServices object](#EncryptionServices) | -| keySource | enum | Yes | The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage - Microsoft.Storage | - - - -### EncryptionServices object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| blob | object | No | The encryption function of the blob storage service. - [EncryptionService object](#EncryptionService) | -| file | object | No | The encryption function of the file storage service. - [EncryptionService object](#EncryptionService) | - - - -### EncryptionService object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | A boolean indicating whether or not the service encrypts the data as it is stored. | - diff --git a/test/Resource/Expected/Storage/2017-06-01/Microsoft.Storage.json b/test/Resource/Expected/Storage/2017-06-01/Microsoft.Storage.json deleted file mode 100644 index f613038..0000000 --- a/test/Resource/Expected/Storage/2017-06-01/Microsoft.Storage.json +++ /dev/null @@ -1,532 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-06-01/Microsoft.Storage.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Storage", - "description": "Microsoft Storage Resource Types", - "resourceDefinitions": { - "storageAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Storage/storageAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-06-01" - ] - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Gets or sets the sku name." - }, - "kind": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Storage", - "BlobStorage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Indicates the type of storage account." - }, - "location": { - "type": "string", - "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/Identity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The parameters used to create the storage account." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "sku", - "kind", - "location", - "properties" - ], - "description": "Microsoft.Storage/storageAccounts" - } - }, - "definitions": { - "CustomDomain": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." - }, - "useSubDomain": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." - } - }, - "required": [ - "name" - ], - "description": "The custom domain assigned to this storage account. This can be set via Update." - }, - "Encryption": { - "type": "object", - "properties": { - "services": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionServices" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of services which support encryption." - }, - "keySource": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft.Storage", - "Microsoft.Keyvault" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault." - }, - "keyvaultproperties": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties provided by key vault." - } - }, - "required": [ - "keySource" - ], - "description": "The encryption settings on the storage account." - }, - "EncryptionService": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A boolean indicating whether or not the service encrypts the data as it is stored." - } - }, - "description": "A service that allows server-side encryption to be used." - }, - "EncryptionServices": { - "type": "object", - "properties": { - "blob": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionService" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption function of the blob storage service." - }, - "file": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionService" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption function of the file storage service." - } - }, - "description": "A list of services that support encryption." - }, - "Identity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity type." - } - }, - "required": [ - "type" - ], - "description": "Identity for the resource." - }, - "IPRule": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed." - }, - "action": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The action of IP ACL rule." - } - }, - "required": [ - "value" - ], - "description": "IP rule with specific IP or IP range in CIDR format." - }, - "KeyVaultProperties": { - "type": "object", - "properties": { - "keyname": { - "type": "string", - "description": "The name of KeyVault key." - }, - "keyversion": { - "type": "string", - "description": "The version of KeyVault key." - }, - "keyvaulturi": { - "type": "string", - "description": "The Uri of KeyVault." - } - }, - "description": "Properties of key vault." - }, - "NetworkRuleSet": { - "type": "object", - "properties": { - "bypass": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Logging", - "Metrics", - "AzureServices" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "virtualNetworkRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sets the virtual network rules" - }, - "ipRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IPRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sets the IP ACL rules" - }, - "defaultAction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the default action of allow or deny when no other rules match." - } - }, - "required": [ - "defaultAction" - ], - "description": "Network rule set" - }, - "Restriction": { - "type": "object", - "properties": { - "reasonCode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "QuotaId", - "NotAvailableForSubscription" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "description": "The restriction because of which SKU cannot be used." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_GRS", - "Standard_RAGRS", - "Standard_ZRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType." - }, - "restrictions": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Restriction" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." - } - }, - "required": [ - "name" - ], - "description": "The SKU of the storage account." - }, - "StorageAccountPropertiesCreateParameters": { - "type": "object", - "properties": { - "customDomain": { - "oneOf": [ - { - "$ref": "#/definitions/CustomDomain" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." - }, - "encryption": { - "oneOf": [ - { - "$ref": "#/definitions/Encryption" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted." - }, - "networkAcls": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkRuleSet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network rule set" - }, - "accessTier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Hot", - "Cool" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing." - }, - "supportsHttpsTrafficOnly": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allows https traffic only to storage service if sets to true." - } - }, - "description": "The parameters used to create the storage account." - }, - "VirtualNetworkRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}." - }, - "action": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The action of virtual network rule." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "provisioning", - "deprovisioning", - "succeeded", - "failed", - "networkSourceDeleted" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets the state of virtual network rule." - } - }, - "required": [ - "id" - ], - "description": "Virtual Network rule." - } - } -} diff --git a/test/Resource/Expected/Storage/2017-06-01/storageAccounts.md b/test/Resource/Expected/Storage/2017-06-01/storageAccounts.md deleted file mode 100644 index 0b9ea7f..0000000 --- a/test/Resource/Expected/Storage/2017-06-01/storageAccounts.md +++ /dev/null @@ -1,187 +0,0 @@ -# Microsoft.Storage/storageAccounts template reference -API Version: 2017-06-01 -## Template format - -To create a Microsoft.Storage/storageAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Storage/storageAccounts", - "apiVersion": "2017-06-01", - "sku": { - "name": "string", - "restrictions": [ - { - "reasonCode": "string" - } - ] - }, - "kind": "string", - "location": "string", - "tags": {}, - "identity": { - "type": "SystemAssigned" - }, - "properties": { - "customDomain": { - "name": "string", - "useSubDomain": "boolean" - }, - "encryption": { - "services": { - "blob": { - "enabled": "boolean" - }, - "file": { - "enabled": "boolean" - } - }, - "keySource": "string", - "keyvaultproperties": { - "keyname": "string", - "keyversion": "string", - "keyvaulturi": "string" - } - }, - "networkAcls": { - "bypass": "string", - "virtualNetworkRules": [ - { - "id": "string", - "action": "Allow", - "state": "string" - } - ], - "ipRules": [ - { - "value": "string", - "action": "Allow" - } - ], - "defaultAction": "string" - }, - "accessTier": "string", - "supportsHttpsTrafficOnly": "boolean" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Storage/storageAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Storage/storageAccounts | -| apiVersion | enum | Yes | 2017-06-01 | -| sku | object | Yes | Required. Gets or sets the sku name. - [Sku object](#Sku) | -| kind | enum | Yes | Required. Indicates the type of storage account. - Storage or BlobStorage | -| location | string | Yes | Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. | -| tags | object | No | 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. | -| identity | object | No | The identity of the resource. - [Identity object](#Identity) | -| properties | object | Yes | The parameters used to create the storage account. - [StorageAccountPropertiesCreateParameters object](#StorageAccountPropertiesCreateParameters) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. - Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS | -| restrictions | array | No | The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. - [Restriction object](#Restriction) | - - - -### Identity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | Yes | The identity type. - SystemAssigned | - - - -### StorageAccountPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| customDomain | object | No | User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. - [CustomDomain object](#CustomDomain) | -| encryption | object | No | Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted. - [Encryption object](#Encryption) | -| networkAcls | object | No | Network rule set - [NetworkRuleSet object](#NetworkRuleSet) | -| accessTier | enum | No | Required for storage accounts where kind = BlobStorage. The access tier used for billing. - Hot or Cool | -| supportsHttpsTrafficOnly | boolean | No | Allows https traffic only to storage service if sets to true. | - - - -### Restriction object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| reasonCode | enum | No | 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. - QuotaId or NotAvailableForSubscription | - - - -### CustomDomain object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. | -| useSubDomain | boolean | No | Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. | - - - -### Encryption object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| services | object | No | List of services which support encryption. - [EncryptionServices object](#EncryptionServices) | -| keySource | enum | Yes | The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. - Microsoft.Storage or Microsoft.Keyvault | -| keyvaultproperties | object | No | Properties provided by key vault. - [KeyVaultProperties object](#KeyVaultProperties) | - - - -### NetworkRuleSet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bypass | enum | No | 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. - None, Logging, Metrics, AzureServices | -| virtualNetworkRules | array | No | Sets the virtual network rules - [VirtualNetworkRule object](#VirtualNetworkRule) | -| ipRules | array | No | Sets the IP ACL rules - [IPRule object](#IPRule) | -| defaultAction | enum | Yes | Specifies the default action of allow or deny when no other rules match. - Allow or Deny | - - - -### EncryptionServices object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| blob | object | No | The encryption function of the blob storage service. - [EncryptionService object](#EncryptionService) | -| file | object | No | The encryption function of the file storage service. - [EncryptionService object](#EncryptionService) | - - - -### KeyVaultProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyname | string | No | The name of KeyVault key. | -| keyversion | string | No | The version of KeyVault key. | -| keyvaulturi | string | No | The Uri of KeyVault. | - - - -### VirtualNetworkRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. | -| action | enum | No | The action of virtual network rule. - Allow | -| state | enum | No | Gets the state of virtual network rule. - provisioning, deprovisioning, succeeded, failed, networkSourceDeleted | - - - -### IPRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | string | Yes | Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. | -| action | enum | No | The action of IP ACL rule. - Allow | - - - -### EncryptionService object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | A boolean indicating whether or not the service encrypts the data as it is stored. | - diff --git a/test/Resource/Expected/Storage/2017-10-01/Microsoft.Storage.json b/test/Resource/Expected/Storage/2017-10-01/Microsoft.Storage.json deleted file mode 100644 index 7d4d96b..0000000 --- a/test/Resource/Expected/Storage/2017-10-01/Microsoft.Storage.json +++ /dev/null @@ -1,533 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-10-01/Microsoft.Storage.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Storage", - "description": "Microsoft Storage Resource Types", - "resourceDefinitions": { - "storageAccounts": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Storage/storageAccounts" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-10-01" - ] - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Gets or sets the sku name." - }, - "kind": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Storage", - "StorageV2", - "BlobStorage" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required. Indicates the type of storage account." - }, - "location": { - "type": "string", - "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/Identity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity of the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The parameters used to create the storage account." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "sku", - "kind", - "location", - "properties" - ], - "description": "Microsoft.Storage/storageAccounts" - } - }, - "definitions": { - "CustomDomain": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." - }, - "useSubDomain": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." - } - }, - "required": [ - "name" - ], - "description": "The custom domain assigned to this storage account. This can be set via Update." - }, - "Encryption": { - "type": "object", - "properties": { - "services": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionServices" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of services which support encryption." - }, - "keySource": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Microsoft.Storage", - "Microsoft.Keyvault" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault." - }, - "keyvaultproperties": { - "oneOf": [ - { - "$ref": "#/definitions/KeyVaultProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Properties provided by key vault." - } - }, - "required": [ - "keySource" - ], - "description": "The encryption settings on the storage account." - }, - "EncryptionService": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A boolean indicating whether or not the service encrypts the data as it is stored." - } - }, - "description": "A service that allows server-side encryption to be used." - }, - "EncryptionServices": { - "type": "object", - "properties": { - "blob": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionService" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption function of the blob storage service." - }, - "file": { - "oneOf": [ - { - "$ref": "#/definitions/EncryptionService" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The encryption function of the file storage service." - } - }, - "description": "A list of services that support encryption." - }, - "Identity": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "SystemAssigned" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The identity type." - } - }, - "required": [ - "type" - ], - "description": "Identity for the resource." - }, - "IPRule": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed." - }, - "action": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The action of IP ACL rule." - } - }, - "required": [ - "value" - ], - "description": "IP rule with specific IP or IP range in CIDR format." - }, - "KeyVaultProperties": { - "type": "object", - "properties": { - "keyname": { - "type": "string", - "description": "The name of KeyVault key." - }, - "keyversion": { - "type": "string", - "description": "The version of KeyVault key." - }, - "keyvaulturi": { - "type": "string", - "description": "The Uri of KeyVault." - } - }, - "description": "Properties of key vault." - }, - "NetworkRuleSet": { - "type": "object", - "properties": { - "bypass": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Logging", - "Metrics", - "AzureServices" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - }, - "virtualNetworkRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sets the virtual network rules" - }, - "ipRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IPRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Sets the IP ACL rules" - }, - "defaultAction": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the default action of allow or deny when no other rules match." - } - }, - "required": [ - "defaultAction" - ], - "description": "Network rule set" - }, - "Restriction": { - "type": "object", - "properties": { - "reasonCode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "QuotaId", - "NotAvailableForSubscription" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "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." - } - }, - "description": "The restriction because of which SKU cannot be used." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_GRS", - "Standard_RAGRS", - "Standard_ZRS", - "Premium_LRS" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType." - }, - "restrictions": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Restriction" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." - } - }, - "required": [ - "name" - ], - "description": "The SKU of the storage account." - }, - "StorageAccountPropertiesCreateParameters": { - "type": "object", - "properties": { - "customDomain": { - "oneOf": [ - { - "$ref": "#/definitions/CustomDomain" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." - }, - "encryption": { - "oneOf": [ - { - "$ref": "#/definitions/Encryption" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted." - }, - "networkAcls": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkRuleSet" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Network rule set" - }, - "accessTier": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Hot", - "Cool" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing." - }, - "supportsHttpsTrafficOnly": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Allows https traffic only to storage service if sets to true." - } - }, - "description": "The parameters used to create the storage account." - }, - "VirtualNetworkRule": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}." - }, - "action": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Allow" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The action of virtual network rule." - }, - "state": { - "oneOf": [ - { - "type": "string", - "enum": [ - "provisioning", - "deprovisioning", - "succeeded", - "failed", - "networkSourceDeleted" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets the state of virtual network rule." - } - }, - "required": [ - "id" - ], - "description": "Virtual Network rule." - } - } -} diff --git a/test/Resource/Expected/Storage/2017-10-01/storageAccounts.md b/test/Resource/Expected/Storage/2017-10-01/storageAccounts.md deleted file mode 100644 index 94df226..0000000 --- a/test/Resource/Expected/Storage/2017-10-01/storageAccounts.md +++ /dev/null @@ -1,187 +0,0 @@ -# Microsoft.Storage/storageAccounts template reference -API Version: 2017-10-01 -## Template format - -To create a Microsoft.Storage/storageAccounts resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Storage/storageAccounts", - "apiVersion": "2017-10-01", - "sku": { - "name": "string", - "restrictions": [ - { - "reasonCode": "string" - } - ] - }, - "kind": "string", - "location": "string", - "tags": {}, - "identity": { - "type": "SystemAssigned" - }, - "properties": { - "customDomain": { - "name": "string", - "useSubDomain": "boolean" - }, - "encryption": { - "services": { - "blob": { - "enabled": "boolean" - }, - "file": { - "enabled": "boolean" - } - }, - "keySource": "string", - "keyvaultproperties": { - "keyname": "string", - "keyversion": "string", - "keyvaulturi": "string" - } - }, - "networkAcls": { - "bypass": "string", - "virtualNetworkRules": [ - { - "id": "string", - "action": "Allow", - "state": "string" - } - ], - "ipRules": [ - { - "value": "string", - "action": "Allow" - } - ], - "defaultAction": "string" - }, - "accessTier": "string", - "supportsHttpsTrafficOnly": "boolean" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Storage/storageAccounts object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Storage/storageAccounts | -| apiVersion | enum | Yes | 2017-10-01 | -| sku | object | Yes | Required. Gets or sets the sku name. - [Sku object](#Sku) | -| kind | enum | Yes | Required. Indicates the type of storage account. - Storage, StorageV2, BlobStorage | -| location | string | Yes | Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. | -| tags | object | No | 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. | -| identity | object | No | The identity of the resource. - [Identity object](#Identity) | -| properties | object | Yes | The parameters used to create the storage account. - [StorageAccountPropertiesCreateParameters object](#StorageAccountPropertiesCreateParameters) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. - Standard_LRS, Standard_GRS, Standard_RAGRS, Standard_ZRS, Premium_LRS | -| restrictions | array | No | The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. - [Restriction object](#Restriction) | - - - -### Identity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | enum | Yes | The identity type. - SystemAssigned | - - - -### StorageAccountPropertiesCreateParameters object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| customDomain | object | No | User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. - [CustomDomain object](#CustomDomain) | -| encryption | object | No | Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted. - [Encryption object](#Encryption) | -| networkAcls | object | No | Network rule set - [NetworkRuleSet object](#NetworkRuleSet) | -| accessTier | enum | No | Required for storage accounts where kind = BlobStorage. The access tier used for billing. - Hot or Cool | -| supportsHttpsTrafficOnly | boolean | No | Allows https traffic only to storage service if sets to true. | - - - -### Restriction object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| reasonCode | enum | No | 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. - QuotaId or NotAvailableForSubscription | - - - -### CustomDomain object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. | -| useSubDomain | boolean | No | Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. | - - - -### Encryption object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| services | object | No | List of services which support encryption. - [EncryptionServices object](#EncryptionServices) | -| keySource | enum | Yes | The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. - Microsoft.Storage or Microsoft.Keyvault | -| keyvaultproperties | object | No | Properties provided by key vault. - [KeyVaultProperties object](#KeyVaultProperties) | - - - -### NetworkRuleSet object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| bypass | enum | No | 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. - None, Logging, Metrics, AzureServices | -| virtualNetworkRules | array | No | Sets the virtual network rules - [VirtualNetworkRule object](#VirtualNetworkRule) | -| ipRules | array | No | Sets the IP ACL rules - [IPRule object](#IPRule) | -| defaultAction | enum | Yes | Specifies the default action of allow or deny when no other rules match. - Allow or Deny | - - - -### EncryptionServices object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| blob | object | No | The encryption function of the blob storage service. - [EncryptionService object](#EncryptionService) | -| file | object | No | The encryption function of the file storage service. - [EncryptionService object](#EncryptionService) | - - - -### KeyVaultProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyname | string | No | The name of KeyVault key. | -| keyversion | string | No | The version of KeyVault key. | -| keyvaulturi | string | No | The Uri of KeyVault. | - - - -### VirtualNetworkRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | Yes | Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. | -| action | enum | No | The action of virtual network rule. - Allow | -| state | enum | No | Gets the state of virtual network rule. - provisioning, deprovisioning, succeeded, failed, networkSourceDeleted | - - - -### IPRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| value | string | Yes | Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. | -| action | enum | No | The action of IP ACL rule. - Allow | - - - -### EncryptionService object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | A boolean indicating whether or not the service encrypts the data as it is stored. | - diff --git a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/Microsoft.TimeSeriesInsights.json b/test/Resource/Expected/TimeSeriesInsights/2017-11-15/Microsoft.TimeSeriesInsights.json deleted file mode 100644 index 9ab5329..0000000 --- a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/Microsoft.TimeSeriesInsights.json +++ /dev/null @@ -1,669 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2017-11-15/Microsoft.TimeSeriesInsights.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.TimeSeriesInsights", - "description": "Microsoft TimeSeriesInsights Resource Types", - "resourceDefinitions": { - "environments": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.TimeSeriesInsights/environments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-11-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key-value pairs of additional properties for the resource." - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/EnvironmentCreationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/environments_eventSources_childResource" - }, - { - "$ref": "#/definitions/environments_referenceDataSets_childResource" - }, - { - "$ref": "#/definitions/environments_accessPolicies_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "sku", - "properties" - ], - "description": "Microsoft.TimeSeriesInsights/environments" - }, - "environments_accessPolicies": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.TimeSeriesInsights/environments/accessPolicies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-11-15" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AccessPolicyResourceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.TimeSeriesInsights/environments/accessPolicies" - }, - "environments_eventSources": { - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/EventHubEventSourceCreateOrUpdateParameters" - }, - { - "$ref": "#/definitions/IoTHubEventSourceCreateOrUpdateParameters" - } - ], - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.TimeSeriesInsights/environments/eventSources" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-11-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key-value pairs of additional properties for the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location" - ], - "description": "Microsoft.TimeSeriesInsights/environments/eventSources" - }, - "environments_referenceDataSets": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.TimeSeriesInsights/environments/referenceDataSets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-11-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key-value pairs of additional properties for the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ReferenceDataSetCreationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.TimeSeriesInsights/environments/referenceDataSets" - } - }, - "definitions": { - "AccessPolicyResourceProperties": { - "type": "object", - "properties": { - "principalObjectId": { - "type": "string", - "description": "The objectId of the principal in Azure Active Directory." - }, - "description": { - "type": "string", - "description": "An description of the access policy." - }, - "roles": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Reader", - "Contributor" - ] - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of roles the principal is assigned on the environment." - } - } - }, - "EnvironmentCreationProperties": { - "type": "object", - "properties": { - "dataRetentionTime": { - "type": "string", - "format": "duration", - "description": "ISO8601 timespan specifying the minimum number of days the environment's events will be available for query." - }, - "storageLimitExceededBehavior": { - "oneOf": [ - { - "type": "string", - "enum": [ - "PurgeOldData", - "PauseIngress" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If \"PauseIngress\" is specified, new events will not be read from the event source. If \"PurgeOldData\" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData." - } - }, - "required": [ - "dataRetentionTime" - ], - "description": "Properties used to create an environment." - }, - "environments_accessPolicies_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "accessPolicies" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-11-15" - ] - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AccessPolicyResourceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.TimeSeriesInsights/environments/accessPolicies" - }, - "environments_eventSources_childResource": { - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/EventHubEventSourceCreateOrUpdateParameters" - }, - { - "$ref": "#/definitions/IoTHubEventSourceCreateOrUpdateParameters" - } - ], - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "eventSources" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-11-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key-value pairs of additional properties for the resource." - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location" - ], - "description": "Microsoft.TimeSeriesInsights/environments/eventSources" - }, - "environments_referenceDataSets_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "referenceDataSets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-11-15" - ] - }, - "location": { - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Key-value pairs of additional properties for the resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/ReferenceDataSetCreationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.TimeSeriesInsights/environments/referenceDataSets" - }, - "EventHubEventSourceCreateOrUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/EventHubEventSourceCreationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "kind": { - "type": "string", - "enum": [ - "Microsoft.EventHub" - ] - } - }, - "required": [ - "properties", - "kind" - ], - "description": "Parameters supplied to the Create or Update Event Source operation for an EventHub event source." - }, - "EventHubEventSourceCreationProperties": { - "type": "object", - "properties": { - "timestampPropertyName": { - "type": "string", - "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." - }, - "eventSourceResourceId": { - "type": "string", - "description": "The resource id of the event source in Azure Resource Manager." - }, - "serviceBusNamespace": { - "type": "string", - "description": "The name of the service bus that contains the event hub." - }, - "eventHubName": { - "type": "string", - "description": "The name of the event hub." - }, - "consumerGroupName": { - "type": "string", - "description": "The name of the event hub's consumer group that holds the partitions from which events will be read." - }, - "keyName": { - "type": "string", - "description": "The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub." - }, - "sharedAccessKey": { - "type": "string", - "description": "The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses." - } - }, - "required": [ - "eventSourceResourceId", - "serviceBusNamespace", - "eventHubName", - "consumerGroupName", - "keyName", - "sharedAccessKey" - ], - "description": "Properties of the EventHub event source that are required on create or update requests." - }, - "IoTHubEventSourceCreateOrUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IoTHubEventSourceCreationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "kind": { - "type": "string", - "enum": [ - "Microsoft.IoTHub" - ] - } - }, - "required": [ - "properties", - "kind" - ], - "description": "Parameters supplied to the Create or Update Event Source operation for an IoTHub event source." - }, - "IoTHubEventSourceCreationProperties": { - "type": "object", - "properties": { - "timestampPropertyName": { - "type": "string", - "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." - }, - "eventSourceResourceId": { - "type": "string", - "description": "The resource id of the event source in Azure Resource Manager." - }, - "iotHubName": { - "type": "string", - "description": "The name of the iot hub." - }, - "consumerGroupName": { - "type": "string", - "description": "The name of the iot hub's consumer group that holds the partitions from which events will be read." - }, - "keyName": { - "type": "string", - "description": "The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub." - }, - "sharedAccessKey": { - "type": "string", - "description": "The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses." - } - }, - "required": [ - "eventSourceResourceId", - "iotHubName", - "consumerGroupName", - "keyName", - "sharedAccessKey" - ], - "description": "Properties of the IoTHub event source that are required on create or update requests." - }, - "ReferenceDataSetCreationProperties": { - "type": "object", - "properties": { - "keyProperties": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ReferenceDataSetKeyProperty" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The list of key properties for the reference data set." - } - }, - "required": [ - "keyProperties" - ], - "description": "Properties used to create a reference data set." - }, - "ReferenceDataSetKeyProperty": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the key property." - }, - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "String", - "Double", - "Bool", - "DateTime" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The type of the key property." - } - }, - "description": "A key property for the reference data set. A reference data set can have multiple key properties." - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "oneOf": [ - { - "type": "string", - "enum": [ - "S1", - "S2" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The name of this SKU." - }, - "capacity": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 10 - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The capacity of the sku. This value can be changed to support scale out of environments after they have been created." - } - }, - "required": [ - "name", - "capacity" - ], - "description": "The sku determines the capacity of the environment, the SLA (in queries-per-minute and total capacity), and the billing rate." - } - } -} diff --git a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments.md b/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments.md deleted file mode 100644 index 68ba0b1..0000000 --- a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments.md +++ /dev/null @@ -1,57 +0,0 @@ -# Microsoft.TimeSeriesInsights/environments template reference -API Version: 2017-11-15 -## Template format - -To create a Microsoft.TimeSeriesInsights/environments resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.TimeSeriesInsights/environments", - "apiVersion": "2017-11-15", - "location": "string", - "tags": {}, - "sku": { - "name": "string", - "capacity": "integer" - }, - "properties": { - "dataRetentionTime": "string", - "storageLimitExceededBehavior": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.TimeSeriesInsights/environments object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.TimeSeriesInsights/environments | -| apiVersion | enum | Yes | 2017-11-15 | -| location | string | Yes | The location of the resource. | -| tags | object | No | Key-value pairs of additional properties for the resource. | -| sku | object | Yes | [Sku object](#Sku) | -| properties | object | Yes | [EnvironmentCreationProperties object](#EnvironmentCreationProperties) | -| resources | array | No | [accessPolicies](./environments/accessPolicies.md) [referenceDataSets](./environments/referenceDataSets.md) [eventSources](./environments/eventSources.md) | - - - -### Sku object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | enum | Yes | The name of this SKU. - S1 or S2 | -| capacity | integer | Yes | The capacity of the sku. This value can be changed to support scale out of environments after they have been created. | - - - -### EnvironmentCreationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| dataRetentionTime | string | Yes | ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. | -| storageLimitExceededBehavior | enum | No | The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. - PurgeOldData or PauseIngress | - diff --git a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/accessPolicies.md b/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/accessPolicies.md deleted file mode 100644 index 5c24611..0000000 --- a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/accessPolicies.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.TimeSeriesInsights/environments/accessPolicies template reference -API Version: 2017-11-15 -## Template format - -To create a Microsoft.TimeSeriesInsights/environments/accessPolicies resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.TimeSeriesInsights/environments/accessPolicies", - "apiVersion": "2017-11-15", - "properties": { - "principalObjectId": "string", - "description": "string", - "roles": [ - "string" - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.TimeSeriesInsights/environments/accessPolicies object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.TimeSeriesInsights/environments/accessPolicies | -| apiVersion | enum | Yes | 2017-11-15 | -| properties | object | Yes | [AccessPolicyResourceProperties object](#AccessPolicyResourceProperties) | - - - -### AccessPolicyResourceProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| principalObjectId | string | No | The objectId of the principal in Azure Active Directory. | -| description | string | No | An description of the access policy. | -| roles | array | No | The list of roles the principal is assigned on the environment. - Reader or Contributor | - diff --git a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/eventSources.md b/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/eventSources.md deleted file mode 100644 index 986fa07..0000000 --- a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/eventSources.md +++ /dev/null @@ -1,29 +0,0 @@ -# Microsoft.TimeSeriesInsights/environments/eventSources template reference -API Version: 2017-11-15 -## Template format - -To create a Microsoft.TimeSeriesInsights/environments/eventSources resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.TimeSeriesInsights/environments/eventSources", - "apiVersion": "2017-11-15", - "location": "string", - "tags": {} -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.TimeSeriesInsights/environments/eventSources object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.TimeSeriesInsights/environments/eventSources | -| apiVersion | enum | Yes | 2017-11-15 | -| location | string | Yes | The location of the resource. | -| tags | object | No | Key-value pairs of additional properties for the resource. | - diff --git a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/referenceDataSets.md b/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/referenceDataSets.md deleted file mode 100644 index 0f8c992..0000000 --- a/test/Resource/Expected/TimeSeriesInsights/2017-11-15/environments/referenceDataSets.md +++ /dev/null @@ -1,53 +0,0 @@ -# Microsoft.TimeSeriesInsights/environments/referenceDataSets template reference -API Version: 2017-11-15 -## Template format - -To create a Microsoft.TimeSeriesInsights/environments/referenceDataSets resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.TimeSeriesInsights/environments/referenceDataSets", - "apiVersion": "2017-11-15", - "location": "string", - "tags": {}, - "properties": { - "keyProperties": [ - { - "name": "string", - "type": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.TimeSeriesInsights/environments/referenceDataSets object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.TimeSeriesInsights/environments/referenceDataSets | -| apiVersion | enum | Yes | 2017-11-15 | -| location | string | Yes | The location of the resource. | -| tags | object | No | Key-value pairs of additional properties for the resource. | -| properties | object | Yes | [ReferenceDataSetCreationProperties object](#ReferenceDataSetCreationProperties) | - - - -### ReferenceDataSetCreationProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyProperties | array | Yes | The list of key properties for the reference data set. - [ReferenceDataSetKeyProperty object](#ReferenceDataSetKeyProperty) | - - - -### ReferenceDataSetKeyProperty object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of the key property. | -| type | enum | No | The type of the key property. - String, Double, Bool, DateTime | - diff --git a/test/Resource/Expected/Web/2015-04-01/Microsoft.DomainRegistration.json b/test/Resource/Expected/Web/2015-04-01/Microsoft.DomainRegistration.json deleted file mode 100644 index 5ca1cd9..0000000 --- a/test/Resource/Expected/Web/2015-04-01/Microsoft.DomainRegistration.json +++ /dev/null @@ -1,425 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-04-01/Microsoft.DomainRegistration.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.DomainRegistration", - "description": "Microsoft DomainRegistration Resource Types", - "resourceDefinitions": { - "domains": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DomainRegistration/domains" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-04-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DomainProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Domain resource specific properties" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/domains_domainOwnershipIdentifiers_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.DomainRegistration/domains" - }, - "domains_domainOwnershipIdentifiers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-04-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DomainOwnershipIdentifierProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "DomainOwnershipIdentifier resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers" - } - }, - "definitions": { - "Address": { - "type": "object", - "properties": { - "address1": { - "type": "string", - "description": "First line of an Address." - }, - "address2": { - "type": "string", - "description": "The second line of the Address. Optional." - }, - "city": { - "type": "string", - "description": "The city for the address." - }, - "country": { - "type": "string", - "description": "The country for the address." - }, - "postalCode": { - "type": "string", - "description": "The postal code for the address." - }, - "state": { - "type": "string", - "description": "The state or province for the address." - } - }, - "required": [ - "address1", - "city", - "country", - "postalCode", - "state" - ], - "description": "Address information for domain registration." - }, - "Contact": { - "type": "object", - "properties": { - "addressMailing": { - "oneOf": [ - { - "$ref": "#/definitions/Address" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Mailing address." - }, - "email": { - "type": "string", - "description": "Email address." - }, - "fax": { - "type": "string", - "description": "Fax number." - }, - "jobTitle": { - "type": "string", - "description": "Job title." - }, - "nameFirst": { - "type": "string", - "description": "First name." - }, - "nameLast": { - "type": "string", - "description": "Last name." - }, - "nameMiddle": { - "type": "string", - "description": "Middle name." - }, - "organization": { - "type": "string", - "description": "Organization contact belongs to." - }, - "phone": { - "type": "string", - "description": "Phone number." - } - }, - "required": [ - "email", - "nameFirst", - "nameLast", - "phone" - ], - "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." - }, - "DomainOwnershipIdentifierProperties": { - "type": "object", - "properties": { - "ownershipId": { - "type": "string", - "description": "Ownership Id." - } - }, - "description": "DomainOwnershipIdentifier resource specific properties" - }, - "DomainProperties": { - "type": "object", - "properties": { - "contactAdmin": { - "oneOf": [ - { - "$ref": "#/definitions/Contact" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Administrative contact." - }, - "contactBilling": { - "oneOf": [ - { - "$ref": "#/definitions/Contact" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Billing contact." - }, - "contactRegistrant": { - "oneOf": [ - { - "$ref": "#/definitions/Contact" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Registrant contact." - }, - "contactTech": { - "oneOf": [ - { - "$ref": "#/definitions/Contact" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Technical contact." - }, - "privacy": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if domain privacy is enabled for this domain; otherwise, false." - }, - "autoRenew": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if the domain should be automatically renewed; otherwise, false." - }, - "consent": { - "oneOf": [ - { - "$ref": "#/definitions/DomainPurchaseConsent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Legal agreement consent." - }, - "dnsType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzureDns", - "DefaultDomainRegistrarDns" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Current DNS type." - }, - "dnsZoneId": { - "type": "string", - "description": "Azure DNS Zone to use" - }, - "targetDnsType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "AzureDns", - "DefaultDomainRegistrarDns" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Target DNS type (would be used for migration)." - }, - "authCode": { - "type": "string" - } - }, - "required": [ - "contactAdmin", - "contactBilling", - "contactRegistrant", - "contactTech", - "consent" - ], - "description": "Domain resource specific properties" - }, - "DomainPurchaseConsent": { - "type": "object", - "properties": { - "agreementKeys": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource." - }, - "agreedBy": { - "type": "string", - "description": "Client IP address." - }, - "agreedAt": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the agreements were accepted." - } - }, - "description": "Domain purchase consent object, representing acceptance of applicable legal agreements." - }, - "domains_domainOwnershipIdentifiers_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "domainOwnershipIdentifiers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-04-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DomainOwnershipIdentifierProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "DomainOwnershipIdentifier resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers" - } - } -} diff --git a/test/Resource/Expected/Web/2015-04-01/domains.md b/test/Resource/Expected/Web/2015-04-01/domains.md deleted file mode 100644 index 281dfa6..0000000 --- a/test/Resource/Expected/Web/2015-04-01/domains.md +++ /dev/null @@ -1,174 +0,0 @@ -# Microsoft.DomainRegistration/domains template reference -API Version: 2015-04-01 -## Template format - -To create a Microsoft.DomainRegistration/domains resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DomainRegistration/domains", - "apiVersion": "2015-04-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "contactAdmin": { - "addressMailing": { - "address1": "string", - "address2": "string", - "city": "string", - "country": "string", - "postalCode": "string", - "state": "string" - }, - "email": "string", - "fax": "string", - "jobTitle": "string", - "nameFirst": "string", - "nameLast": "string", - "nameMiddle": "string", - "organization": "string", - "phone": "string" - }, - "contactBilling": { - "addressMailing": { - "address1": "string", - "address2": "string", - "city": "string", - "country": "string", - "postalCode": "string", - "state": "string" - }, - "email": "string", - "fax": "string", - "jobTitle": "string", - "nameFirst": "string", - "nameLast": "string", - "nameMiddle": "string", - "organization": "string", - "phone": "string" - }, - "contactRegistrant": { - "addressMailing": { - "address1": "string", - "address2": "string", - "city": "string", - "country": "string", - "postalCode": "string", - "state": "string" - }, - "email": "string", - "fax": "string", - "jobTitle": "string", - "nameFirst": "string", - "nameLast": "string", - "nameMiddle": "string", - "organization": "string", - "phone": "string" - }, - "contactTech": { - "addressMailing": { - "address1": "string", - "address2": "string", - "city": "string", - "country": "string", - "postalCode": "string", - "state": "string" - }, - "email": "string", - "fax": "string", - "jobTitle": "string", - "nameFirst": "string", - "nameLast": "string", - "nameMiddle": "string", - "organization": "string", - "phone": "string" - }, - "privacy": "boolean", - "autoRenew": "boolean", - "consent": { - "agreementKeys": [ - "string" - ], - "agreedBy": "string", - "agreedAt": "string" - }, - "dnsType": "string", - "dnsZoneId": "string", - "targetDnsType": "string", - "authCode": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DomainRegistration/domains object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DomainRegistration/domains | -| apiVersion | enum | Yes | 2015-04-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Domain resource specific properties - [DomainProperties object](#DomainProperties) | -| resources | array | No | [domainOwnershipIdentifiers](./domains/domainOwnershipIdentifiers.md) | - - - -### DomainProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| contactAdmin | object | Yes | Administrative contact. - [Contact object](#Contact) | -| contactBilling | object | Yes | Billing contact. - [Contact object](#Contact) | -| contactRegistrant | object | Yes | Registrant contact. - [Contact object](#Contact) | -| contactTech | object | Yes | Technical contact. - [Contact object](#Contact) | -| privacy | boolean | No | true if domain privacy is enabled for this domain; otherwise, false. | -| autoRenew | boolean | No | true if the domain should be automatically renewed; otherwise, false. | -| consent | object | Yes | Legal agreement consent. - [DomainPurchaseConsent object](#DomainPurchaseConsent) | -| dnsType | enum | No | Current DNS type. - AzureDns or DefaultDomainRegistrarDns | -| dnsZoneId | string | No | Azure DNS Zone to use | -| targetDnsType | enum | No | Target DNS type (would be used for migration). - AzureDns or DefaultDomainRegistrarDns | -| authCode | string | No | | - - - -### Contact object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| addressMailing | object | No | Mailing address. - [Address object](#Address) | -| email | string | Yes | Email address. | -| fax | string | No | Fax number. | -| jobTitle | string | No | Job title. | -| nameFirst | string | Yes | First name. | -| nameLast | string | Yes | Last name. | -| nameMiddle | string | No | Middle name. | -| organization | string | No | Organization contact belongs to. | -| phone | string | Yes | Phone number. | - - - -### DomainPurchaseConsent object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| agreementKeys | array | No | List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. - string | -| agreedBy | string | No | Client IP address. | -| agreedAt | string | No | Timestamp when the agreements were accepted. | - - - -### Address object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| address1 | string | Yes | First line of an Address. | -| address2 | string | No | The second line of the Address. Optional. | -| city | string | Yes | The city for the address. | -| country | string | Yes | The country for the address. | -| postalCode | string | Yes | The postal code for the address. | -| state | string | Yes | The state or province for the address. | - diff --git a/test/Resource/Expected/Web/2015-04-01/domains/domainOwnershipIdentifiers.md b/test/Resource/Expected/Web/2015-04-01/domains/domainOwnershipIdentifiers.md deleted file mode 100644 index d23fdb1..0000000 --- a/test/Resource/Expected/Web/2015-04-01/domains/domainOwnershipIdentifiers.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers template reference -API Version: 2015-04-01 -## Template format - -To create a Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers", - "apiVersion": "2015-04-01", - "kind": "string", - "properties": { - "ownershipId": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers | -| apiVersion | enum | Yes | 2015-04-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | DomainOwnershipIdentifier resource specific properties - [DomainOwnershipIdentifierProperties object](#DomainOwnershipIdentifierProperties) | - - - -### DomainOwnershipIdentifierProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ownershipId | string | No | Ownership Id. | - diff --git a/test/Resource/Expected/Web/2015-08-01/Microsoft.CertificateRegistration.json b/test/Resource/Expected/Web/2015-08-01/Microsoft.CertificateRegistration.json deleted file mode 100644 index 6a04bca..0000000 --- a/test/Resource/Expected/Web/2015-08-01/Microsoft.CertificateRegistration.json +++ /dev/null @@ -1,305 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2015-08-01/Microsoft.CertificateRegistration.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.CertificateRegistration", - "description": "Microsoft CertificateRegistration Resource Types", - "resourceDefinitions": { - "certificateOrders": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CertificateRegistration/certificateOrders" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AppServiceCertificateOrderProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AppServiceCertificateOrder resource specific properties" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/certificateOrders_certificates_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.CertificateRegistration/certificateOrders" - }, - "certificateOrders_certificates": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.CertificateRegistration/certificateOrders/certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AppServiceCertificate" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Core resource properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.CertificateRegistration/certificateOrders/certificates" - } - }, - "definitions": { - "AppServiceCertificate": { - "type": "object", - "properties": { - "keyVaultId": { - "type": "string", - "description": "Key Vault resource Id." - }, - "keyVaultSecretName": { - "type": "string", - "description": "Key Vault secret name." - } - }, - "description": "Key Vault container for a certificate that is purchased through Azure." - }, - "AppServiceCertificateOrderProperties": { - "type": "object", - "properties": { - "certificates": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AppServiceCertificate" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "State of the Key Vault secret." - }, - "distinguishedName": { - "type": "string", - "description": "Certificate distinguished name." - }, - "validityInYears": { - "oneOf": [ - { - "type": "integer", - "minimum": 1, - "maximum": 3, - "default": "1" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Duration in years (must be between 1 and 3)." - }, - "keySize": { - "oneOf": [ - { - "type": "integer", - "default": "2048" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Certificate key size." - }, - "productType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "StandardDomainValidatedSsl", - "StandardDomainValidatedWildCardSsl" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Certificate product type." - }, - "autoRenew": { - "oneOf": [ - { - "type": "boolean", - "default": true - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if the certificate should be automatically renewed when it expires; otherwise, false." - }, - "csr": { - "type": "string", - "description": "Last CSR that was created for this order." - } - }, - "required": [ - "productType" - ], - "description": "AppServiceCertificateOrder resource specific properties" - }, - "certificateOrders_certificates_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2015-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AppServiceCertificate" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Core resource properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.CertificateRegistration/certificateOrders/certificates" - } - } -} diff --git a/test/Resource/Expected/Web/2015-08-01/certificateOrders.md b/test/Resource/Expected/Web/2015-08-01/certificateOrders.md deleted file mode 100644 index ab1bb4f..0000000 --- a/test/Resource/Expected/Web/2015-08-01/certificateOrders.md +++ /dev/null @@ -1,56 +0,0 @@ -# Microsoft.CertificateRegistration/certificateOrders template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.CertificateRegistration/certificateOrders resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CertificateRegistration/certificateOrders", - "apiVersion": "2015-08-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "certificates": {}, - "distinguishedName": "string", - "validityInYears": "integer", - "keySize": "integer", - "productType": "string", - "autoRenew": "boolean", - "csr": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CertificateRegistration/certificateOrders object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CertificateRegistration/certificateOrders | -| apiVersion | enum | Yes | 2015-08-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | AppServiceCertificateOrder resource specific properties - [AppServiceCertificateOrderProperties object](#AppServiceCertificateOrderProperties) | -| resources | array | No | [certificates](./certificateOrders/certificates.md) | - - - -### AppServiceCertificateOrderProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| certificates | object | No | State of the Key Vault secret. | -| distinguishedName | string | No | Certificate distinguished name. | -| validityInYears | integer | No | Duration in years (must be between 1 and 3). | -| keySize | integer | No | Certificate key size. | -| productType | enum | Yes | Certificate product type. - StandardDomainValidatedSsl or StandardDomainValidatedWildCardSsl | -| autoRenew | boolean | No | true if the certificate should be automatically renewed when it expires; otherwise, false. | -| csr | string | No | Last CSR that was created for this order. | - diff --git a/test/Resource/Expected/Web/2015-08-01/certificateOrders/certificates.md b/test/Resource/Expected/Web/2015-08-01/certificateOrders/certificates.md deleted file mode 100644 index 2082fde..0000000 --- a/test/Resource/Expected/Web/2015-08-01/certificateOrders/certificates.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.CertificateRegistration/certificateOrders/certificates template reference -API Version: 2015-08-01 -## Template format - -To create a Microsoft.CertificateRegistration/certificateOrders/certificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.CertificateRegistration/certificateOrders/certificates", - "apiVersion": "2015-08-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "keyVaultId": "string", - "keyVaultSecretName": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.CertificateRegistration/certificateOrders/certificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.CertificateRegistration/certificateOrders/certificates | -| apiVersion | enum | Yes | 2015-08-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Core resource properties - [AppServiceCertificate object](#AppServiceCertificate) | - - - -### AppServiceCertificate object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| keyVaultId | string | No | Key Vault resource Id. | -| keyVaultSecretName | string | No | Key Vault secret name. | - diff --git a/test/Resource/Expected/Web/2016-03-01/Microsoft.Web.json b/test/Resource/Expected/Web/2016-03-01/Microsoft.Web.json deleted file mode 100644 index aa8d15c..0000000 --- a/test/Resource/Expected/Web/2016-03-01/Microsoft.Web.json +++ /dev/null @@ -1,125 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-03-01/Microsoft.Web.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Web", - "description": "Microsoft Web Resource Types", - "resourceDefinitions": { - "certificates": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/certificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-03-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/CertificateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Certificate resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/certificates" - } - }, - "definitions": { - "CertificateProperties": { - "type": "object", - "properties": { - "hostNames": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Host names the certificate applies to." - }, - "pfxBlob": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Pfx blob." - }, - "password": { - "type": "string", - "description": "Certificate password." - }, - "keyVaultId": { - "type": "string", - "description": "Key Vault Csm resource Id." - }, - "keyVaultSecretName": { - "type": "string", - "description": "Key Vault secret name." - }, - "serverFarmId": { - "type": "string", - "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"." - } - }, - "required": [ - "password" - ], - "description": "Certificate resource specific properties" - } - } -} diff --git a/test/Resource/Expected/Web/2016-03-01/certificates.md b/test/Resource/Expected/Web/2016-03-01/certificates.md deleted file mode 100644 index 36e5432..0000000 --- a/test/Resource/Expected/Web/2016-03-01/certificates.md +++ /dev/null @@ -1,56 +0,0 @@ -# Microsoft.Web/certificates template reference -API Version: 2016-03-01 -## Template format - -To create a Microsoft.Web/certificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/certificates", - "apiVersion": "2016-03-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "hostNames": [ - "string" - ], - "pfxBlob": [ - "integer" - ], - "password": "string", - "keyVaultId": "string", - "keyVaultSecretName": "string", - "serverFarmId": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/certificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/certificates | -| apiVersion | enum | Yes | 2016-03-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Certificate resource specific properties - [CertificateProperties object](#CertificateProperties) | - - - -### CertificateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| hostNames | array | No | Host names the certificate applies to. - string | -| pfxBlob | array | No | Pfx blob. - integer | -| password | string | Yes | Certificate password. | -| keyVaultId | string | No | Key Vault Csm resource Id. | -| keyVaultSecretName | string | No | Key Vault secret name. | -| serverFarmId | string | No | Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". | - diff --git a/test/Resource/Expected/Web/2016-03-01/sourcecontrols.md b/test/Resource/Expected/Web/2016-03-01/sourcecontrols.md deleted file mode 100644 index 3d22866..0000000 --- a/test/Resource/Expected/Web/2016-03-01/sourcecontrols.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Web/sourcecontrols template reference -API Version: 2016-03-01 -## Template format - -To create a Microsoft.Web/sourcecontrols resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sourcecontrols", - "apiVersion": "2016-03-01", - "kind": "string", - "properties": { - "name": "string", - "token": "string", - "tokenSecret": "string", - "refreshToken": "string", - "expirationTime": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sourcecontrols object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sourcecontrols | -| apiVersion | enum | Yes | 2016-03-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | SourceControl resource specific properties - [SourceControlProperties object](#SourceControlProperties) | - - - -### SourceControlProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Name or source control type. | -| token | string | No | OAuth access token. | -| tokenSecret | string | No | OAuth access token secret. | -| refreshToken | string | No | OAuth refresh token. | -| expirationTime | string | No | OAuth token expiration. | - diff --git a/test/Resource/Expected/Web/2016-08-01/Microsoft.Web.json b/test/Resource/Expected/Web/2016-08-01/Microsoft.Web.json deleted file mode 100644 index 170db53..0000000 --- a/test/Resource/Expected/Web/2016-08-01/Microsoft.Web.json +++ /dev/null @@ -1,3950 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-08-01/Microsoft.Web.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Web", - "description": "Microsoft Web Resource Types", - "resourceDefinitions": { - "sites": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SiteProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Site resource specific properties" - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedServiceIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/sites_deployments_childResource" - }, - { - "$ref": "#/definitions/sites_domainOwnershipIdentifiers_childResource" - }, - { - "$ref": "#/definitions/sites_functions_childResource" - }, - { - "$ref": "#/definitions/sites_hostNameBindings_childResource" - }, - { - "$ref": "#/definitions/sites_hybridconnection_childResource" - }, - { - "$ref": "#/definitions/sites_premieraddons_childResource" - }, - { - "$ref": "#/definitions/sites_publicCertificates_childResource" - }, - { - "$ref": "#/definitions/sites_siteextensions_childResource" - }, - { - "$ref": "#/definitions/sites_slots_childResource" - }, - { - "$ref": "#/definitions/sites_virtualNetworkConnections_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/sites" - }, - "sites_deployments": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/deployments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DeploymentProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Deployment resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/deployments" - }, - "sites_domainOwnershipIdentifiers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/domainOwnershipIdentifiers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IdentifierProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/domainOwnershipIdentifiers" - }, - "sites_functions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/functions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FunctionEnvelopeProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "FunctionEnvelope resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/functions" - }, - "sites_hostNameBindings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/hostNameBindings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/HostNameBindingProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HostNameBinding resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/hostNameBindings" - }, - "sites_hybridconnection": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/hybridconnection" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelayServiceConnectionEntityProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "RelayServiceConnectionEntity resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/hybridconnection" - }, - "sites_hybridConnectionNamespaces_relays": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/hybridConnectionNamespaces/relays" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/HybridConnectionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HybridConnection resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/hybridConnectionNamespaces/relays" - }, - "sites_premieraddons": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/premieraddons" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PremierAddOnProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PremierAddOn resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/sites/premieraddons" - }, - "sites_publicCertificates": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/publicCertificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicCertificateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PublicCertificate resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/publicCertificates" - }, - "sites_siteextensions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/siteextensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Web/sites/siteextensions" - }, - "sites_slots": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SiteProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Site resource specific properties" - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedServiceIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/sites_slots_deployments_childResource" - }, - { - "$ref": "#/definitions/sites_slots_domainOwnershipIdentifiers_childResource" - }, - { - "$ref": "#/definitions/sites_slots_functions_childResource" - }, - { - "$ref": "#/definitions/sites_slots_hostNameBindings_childResource" - }, - { - "$ref": "#/definitions/sites_slots_hybridconnection_childResource" - }, - { - "$ref": "#/definitions/sites_slots_premieraddons_childResource" - }, - { - "$ref": "#/definitions/sites_slots_publicCertificates_childResource" - }, - { - "$ref": "#/definitions/sites_slots_siteextensions_childResource" - }, - { - "$ref": "#/definitions/sites_slots_virtualNetworkConnections_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/sites/slots" - }, - "sites_slots_deployments": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/deployments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DeploymentProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Deployment resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/deployments" - }, - "sites_slots_domainOwnershipIdentifiers": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/domainOwnershipIdentifiers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IdentifierProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/domainOwnershipIdentifiers" - }, - "sites_slots_functions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/functions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FunctionEnvelopeProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "FunctionEnvelope resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/functions" - }, - "sites_slots_hostNameBindings": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/hostNameBindings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/HostNameBindingProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HostNameBinding resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/hostNameBindings" - }, - "sites_slots_hybridconnection": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/hybridconnection" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelayServiceConnectionEntityProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "RelayServiceConnectionEntity resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/hybridconnection" - }, - "sites_slots_hybridConnectionNamespaces_relays": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/HybridConnectionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HybridConnection resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays" - }, - "sites_slots_premieraddons": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/premieraddons" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PremierAddOnProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PremierAddOn resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/sites/slots/premieraddons" - }, - "sites_slots_publicCertificates": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/publicCertificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicCertificateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PublicCertificate resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/publicCertificates" - }, - "sites_slots_siteextensions": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/siteextensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Web/sites/slots/siteextensions" - }, - "sites_slots_virtualNetworkConnections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/virtualNetworkConnections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetInfoProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetInfo resource specific properties" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/sites_slots_virtualNetworkConnections_gateways_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/virtualNetworkConnections" - }, - "sites_slots_virtualNetworkConnections_gateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetGatewayProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetGateway resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways" - }, - "sites_virtualNetworkConnections": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/virtualNetworkConnections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetInfoProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetInfo resource specific properties" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/sites_virtualNetworkConnections_gateways_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/virtualNetworkConnections" - }, - "sites_virtualNetworkConnections_gateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/sites/virtualNetworkConnections/gateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetGatewayProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetGateway resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/virtualNetworkConnections/gateways" - } - }, - "definitions": { - "ApiDefinitionInfo": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL of the API definition." - } - }, - "description": "Information about the formal API definition for the app." - }, - "AutoHealActions": { - "type": "object", - "properties": { - "actionType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Recycle", - "LogEvent", - "CustomAction" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Predefined action to be taken." - }, - "customAction": { - "oneOf": [ - { - "$ref": "#/definitions/AutoHealCustomAction" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Custom action to be taken." - }, - "minProcessExecutionTime": { - "type": "string", - "description": "Minimum time the process must execute\nbefore taking the action" - } - }, - "description": "Actions which to take by the auto-heal module when a rule is triggered." - }, - "AutoHealCustomAction": { - "type": "object", - "properties": { - "exe": { - "type": "string", - "description": "Executable to be run." - }, - "parameters": { - "type": "string", - "description": "Parameters for the executable." - } - }, - "description": "Custom action to be executed\nwhen an auto heal rule is triggered." - }, - "AutoHealRules": { - "type": "object", - "properties": { - "triggers": { - "oneOf": [ - { - "$ref": "#/definitions/AutoHealTriggers" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Conditions that describe when to execute the auto-heal actions." - }, - "actions": { - "oneOf": [ - { - "$ref": "#/definitions/AutoHealActions" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Actions to be executed when a rule is triggered." - } - }, - "description": "Rules that can be defined for auto-heal." - }, - "AutoHealTriggers": { - "type": "object", - "properties": { - "requests": { - "oneOf": [ - { - "$ref": "#/definitions/RequestsBasedTrigger" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A rule based on total requests." - }, - "privateBytesInKB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A rule based on private bytes." - }, - "statusCodes": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/StatusCodesBasedTrigger" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A rule based on status codes." - }, - "slowRequests": { - "oneOf": [ - { - "$ref": "#/definitions/SlowRequestsBasedTrigger" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A rule based on request execution time." - } - }, - "description": "Triggers for auto-heal." - }, - "CloningInfo": { - "type": "object", - "properties": { - "correlationId": { - "oneOf": [ - { - "type": "string", - "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot." - }, - "overwrite": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true to overwrite destination app; otherwise, false." - }, - "cloneCustomHostNames": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true to clone custom hostnames from source app; otherwise, false." - }, - "cloneSourceControl": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true to clone source control from source app; otherwise, false." - }, - "sourceWebAppId": { - "type": "string", - "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": "string", - "description": "App Service Environment." - }, - "appSettingsOverrides": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "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": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true to configure load balancing for source and destination app." - }, - "trafficManagerProfileId": { - "type": "string", - "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": "string", - "description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist." - }, - "ignoreQuotas": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if quotas should be ignored; otherwise, false." - } - }, - "required": [ - "sourceWebAppId" - ], - "description": "Information needed for cloning operation." - }, - "ConnStringInfo": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of connection string." - }, - "connectionString": { - "type": "string", - "description": "Connection string value." - }, - "type": { - "oneOf": [ - { - "type": "string", - "enum": [ - "MySql", - "SQLServer", - "SQLAzure", - "Custom", - "NotificationHub", - "ServiceBus", - "EventHub", - "ApiHub", - "DocDb", - "RedisCache", - "PostgreSQL" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Type of database." - } - }, - "description": "Database connection string information." - }, - "CorsSettings": { - "type": "object", - "properties": { - "allowedOrigins": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "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." - } - }, - "description": "Cross-Origin Resource Sharing (CORS) settings for the app." - }, - "DeploymentProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier for deployment." - }, - "status": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Deployment status." - }, - "message": { - "type": "string", - "description": "Details about deployment status." - }, - "author": { - "type": "string", - "description": "Who authored the deployment." - }, - "deployer": { - "type": "string", - "description": "Who performed the deployment." - }, - "authorEmail": { - "type": "string", - "description": "Author email." - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "Start time." - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "End time." - }, - "active": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "True if deployment is currently active, false if completed and null if not started." - }, - "details": { - "type": "string", - "description": "Details on deployment." - } - }, - "description": "Deployment resource specific properties" - }, - "Experiments": { - "type": "object", - "properties": { - "rampUpRules": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/RampUpRule" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "List of ramp-up rules." - } - }, - "description": "Routing rules in production experiments." - }, - "FunctionEnvelopeProperties": { - "type": "object", - "properties": { - "scriptRootPathHref": { - "type": "string", - "description": "Script root path URI." - }, - "scriptHref": { - "type": "string", - "description": "Script URI." - }, - "configHref": { - "type": "string", - "description": "Config URI." - }, - "secretsFileHref": { - "type": "string", - "description": "Secrets file URI." - }, - "href": { - "type": "string", - "description": "Function URI." - }, - "config": { - "type": "object", - "properties": {}, - "description": "Config information." - }, - "files": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "File list." - }, - "testData": { - "type": "string", - "description": "Test data used when testing via the Azure Portal." - } - }, - "description": "FunctionEnvelope resource specific properties" - }, - "HandlerMapping": { - "type": "object", - "properties": { - "extension": { - "type": "string", - "description": "Requests with this extension will be handled using the specified FastCGI application." - }, - "scriptProcessor": { - "type": "string", - "description": "The absolute path to the FastCGI application." - }, - "arguments": { - "type": "string", - "description": "Command-line arguments to be passed to the script processor." - } - }, - "description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." - }, - "HostingEnvironmentProfile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID of the App Service Environment." - } - }, - "description": "Specification for an App Service Environment to use for this resource." - }, - "HostNameBindingProperties": { - "type": "object", - "properties": { - "siteName": { - "type": "string", - "description": "App Service app name." - }, - "domainId": { - "type": "string", - "description": "Fully qualified ARM domain resource URI." - }, - "azureResourceName": { - "type": "string", - "description": "Azure resource name." - }, - "azureResourceType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Website", - "TrafficManager" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Azure resource type." - }, - "customHostNameDnsRecordType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "CName", - "A" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Custom DNS record type." - }, - "hostNameType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Verified", - "Managed" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Hostname type." - }, - "sslState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "SniEnabled", - "IpBasedEnabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL type." - }, - "thumbprint": { - "type": "string", - "description": "SSL certificate thumbprint" - } - }, - "description": "HostNameBinding resource specific properties" - }, - "HostNameSslState": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Hostname." - }, - "sslState": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Disabled", - "SniEnabled", - "IpBasedEnabled" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SSL type." - }, - "virtualIP": { - "type": "string", - "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled." - }, - "thumbprint": { - "type": "string", - "description": "SSL certificate thumbprint." - }, - "toUpdate": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Set to true to update existing hostname." - }, - "hostType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Standard", - "Repository" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Indicates whether the hostname is a standard or repository hostname." - } - }, - "description": "SSL-enabled hostname." - }, - "HybridConnectionProperties": { - "type": "object", - "properties": { - "serviceBusNamespace": { - "type": "string", - "description": "The name of the Service Bus namespace." - }, - "relayName": { - "type": "string", - "description": "The name of the Service Bus relay." - }, - "relayArmUri": { - "type": "string", - "description": "The ARM URI to the Service Bus relay." - }, - "hostname": { - "type": "string", - "description": "The hostname of the endpoint." - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "The port of the endpoint." - }, - "sendKeyName": { - "type": "string", - "description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus." - }, - "sendKeyValue": { - "type": "string", - "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": "string", - "description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net" - } - }, - "description": "HybridConnection resource specific properties" - }, - "IdentifierProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "String representation of the identity." - } - }, - "description": "Identifier resource specific properties" - }, - "IpSecurityRestriction": { - "type": "object", - "properties": { - "ipAddress": { - "type": "string", - "description": "IP address the security restriction is valid for." - }, - "subnetMask": { - "type": "string", - "description": "Subnet mask for the range of IP addresses the restriction is valid for." - } - }, - "required": [ - "ipAddress" - ], - "description": "IP security restriction on an app." - }, - "ManagedServiceIdentity": { - "type": "object", - "properties": { - "type": { - "type": "object", - "properties": {}, - "description": "Type of managed service identity." - } - }, - "description": "Managed service identity." - }, - "NameValuePair": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Pair name." - }, - "value": { - "type": "string", - "description": "Pair value." - } - }, - "description": "Name value pair." - }, - "PremierAddOnProperties": { - "type": "object", - "properties": { - "sku": { - "type": "string", - "description": "Premier add on SKU." - }, - "product": { - "type": "string", - "description": "Premier add on Product." - }, - "vendor": { - "type": "string", - "description": "Premier add on Vendor." - }, - "name": { - "type": "string", - "description": "Premier add on Name." - }, - "location": { - "type": "string", - "description": "Premier add on Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Premier add on Tags." - }, - "marketplacePublisher": { - "type": "string", - "description": "Premier add on Marketplace publisher." - }, - "marketplaceOffer": { - "type": "string", - "description": "Premier add on Marketplace offer." - } - }, - "description": "PremierAddOn resource specific properties" - }, - "PublicCertificateProperties": { - "type": "object", - "properties": { - "blob": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public Certificate byte array" - }, - "publicCertificateLocation": { - "oneOf": [ - { - "type": "string", - "enum": [ - "CurrentUserMy", - "LocalMachineMy", - "Unknown" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Public Certificate Location." - } - }, - "description": "PublicCertificate resource specific properties" - }, - "PushSettings": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PushSettingsProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PushSettings resource specific properties" - } - }, - "description": "Push settings for the App." - }, - "PushSettingsProperties": { - "type": "object", - "properties": { - "isPushEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Gets or sets a flag indicating whether the Push endpoint is enabled." - }, - "tagWhitelistJson": { - "type": "string", - "description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint." - }, - "tagsRequiringAuth": { - "type": "string", - "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": "string", - "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." - } - }, - "required": [ - "isPushEnabled" - ], - "description": "PushSettings resource specific properties" - }, - "RampUpRule": { - "type": "object", - "properties": { - "actionHostName": { - "type": "string", - "description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net." - }, - "reroutePercentage": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Percentage of the traffic which will be redirected to ActionHostName." - }, - "changeStep": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl." - }, - "changeIntervalInMinutes": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies interval in mimuntes to reevaluate ReroutePercentage." - }, - "minReroutePercentage": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies lower boundary above which ReroutePercentage will stay." - }, - "maxReroutePercentage": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies upper boundary below which ReroutePercentage will stay." - }, - "changeDecisionCallbackUrl": { - "type": "string", - "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": "string", - "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment." - } - }, - "description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance." - }, - "RelayServiceConnectionEntityProperties": { - "type": "object", - "properties": { - "entityName": { - "type": "string" - }, - "entityConnectionString": { - "type": "string" - }, - "resourceType": { - "type": "string" - }, - "resourceConnectionString": { - "type": "string" - }, - "hostname": { - "type": "string" - }, - "port": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - }, - "biztalkUri": { - "type": "string" - } - }, - "description": "RelayServiceConnectionEntity resource specific properties" - }, - "RequestsBasedTrigger": { - "type": "object", - "properties": { - "count": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request Count." - }, - "timeInterval": { - "type": "string", - "description": "Time interval." - } - }, - "description": "Trigger based on total requests." - }, - "SiteConfig": { - "type": "object", - "properties": { - "numberOfWorkers": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of workers." - }, - "defaultDocuments": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default documents." - }, - "netFrameworkVersion": { - "type": "string", - "default": "v4.6", - "description": ".NET Framework version." - }, - "phpVersion": { - "type": "string", - "description": "Version of PHP." - }, - "pythonVersion": { - "type": "string", - "description": "Version of Python." - }, - "nodeVersion": { - "type": "string", - "description": "Version of Node.js." - }, - "linuxFxVersion": { - "type": "string", - "description": "Linux App Framework and version" - }, - "requestTracingEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if request tracing is enabled; otherwise, false." - }, - "requestTracingExpirationTime": { - "type": "string", - "format": "date-time", - "description": "Request tracing expiration time." - }, - "remoteDebuggingEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if remote debugging is enabled; otherwise, false." - }, - "remoteDebuggingVersion": { - "type": "string", - "description": "Remote debugging version." - }, - "httpLoggingEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if HTTP logging is enabled; otherwise, false." - }, - "logsDirectorySizeLimit": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HTTP logs directory size limit." - }, - "detailedErrorLoggingEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if detailed error logging is enabled; otherwise, false." - }, - "publishingUsername": { - "type": "string", - "description": "Publishing user name." - }, - "appSettings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NameValuePair" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Application settings." - }, - "connectionStrings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/ConnStringInfo" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Connection strings." - }, - "handlerMappings": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/HandlerMapping" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Handler mappings." - }, - "documentRoot": { - "type": "string", - "description": "Document root." - }, - "scmType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Dropbox", - "Tfs", - "LocalGit", - "GitHub", - "CodePlexGit", - "CodePlexHg", - "BitbucketGit", - "BitbucketHg", - "ExternalGit", - "ExternalHg", - "OneDrive", - "VSO" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SCM type." - }, - "use32BitWorkerProcess": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true to use 32-bit worker process; otherwise, false." - }, - "webSocketsEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if WebSocket is enabled; otherwise, false." - }, - "alwaysOn": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if Always On is enabled; otherwise, false." - }, - "javaVersion": { - "type": "string", - "description": "Java version." - }, - "javaContainer": { - "type": "string", - "description": "Java container." - }, - "javaContainerVersion": { - "type": "string", - "description": "Java container version." - }, - "appCommandLine": { - "type": "string", - "description": "App command line to launch." - }, - "managedPipelineMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Integrated", - "Classic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Managed pipeline mode." - }, - "virtualApplications": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualApplication" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual applications." - }, - "loadBalancing": { - "oneOf": [ - { - "type": "string", - "enum": [ - "WeightedRoundRobin", - "LeastRequests", - "LeastResponseTime", - "WeightedTotalTraffic", - "RequestHash" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Site load balancing." - }, - "experiments": { - "oneOf": [ - { - "$ref": "#/definitions/Experiments" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "This is work around for polymophic types." - }, - "limits": { - "oneOf": [ - { - "$ref": "#/definitions/SiteLimits" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Site limits." - }, - "autoHealEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if Auto Heal is enabled; otherwise, false." - }, - "autoHealRules": { - "oneOf": [ - { - "$ref": "#/definitions/AutoHealRules" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Auto Heal rules." - }, - "tracingOptions": { - "type": "string", - "description": "Tracing options." - }, - "vnetName": { - "type": "string", - "description": "Virtual Network name." - }, - "cors": { - "oneOf": [ - { - "$ref": "#/definitions/CorsSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Cross-Origin Resource Sharing (CORS) settings." - }, - "push": { - "oneOf": [ - { - "$ref": "#/definitions/PushSettings" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Push endpoint settings." - }, - "apiDefinition": { - "oneOf": [ - { - "$ref": "#/definitions/ApiDefinitionInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Information about the formal API definition for the app." - }, - "autoSwapSlotName": { - "type": "string", - "description": "Auto-swap slot name." - }, - "localMySqlEnabled": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true to enable local MySQL; otherwise, false." - }, - "ipSecurityRestrictions": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/IpSecurityRestriction" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "IP security restrictions." - } - }, - "description": "Configuration of an App Service app." - }, - "SiteLimits": { - "type": "object", - "properties": { - "maxPercentageCpu": { - "oneOf": [ - { - "type": "number" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum allowed CPU usage percentage." - }, - "maxMemoryInMb": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum allowed memory usage in MB." - }, - "maxDiskSizeInMb": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum allowed disk size usage in MB." - } - }, - "description": "Metric limits set on an app." - }, - "SiteProperties": { - "type": "object", - "properties": { - "enabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)." - }, - "hostNameSslStates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/HostNameSslState" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames." - }, - "serverFarmId": { - "type": "string", - "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"." - }, - "reserved": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if reserved; otherwise, false." - }, - "siteConfig": { - "oneOf": [ - { - "$ref": "#/definitions/SiteConfig" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Configuration of the app." - }, - "scmSiteAlsoStopped": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false." - }, - "hostingEnvironmentProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HostingEnvironmentProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "App Service Environment to use for the app." - }, - "clientAffinityEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "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": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false." - }, - "hostNamesDisabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process." - }, - "containerSize": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Size of the function container." - }, - "dailyMemoryTimeQuota": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only)." - }, - "cloningInfo": { - "oneOf": [ - { - "$ref": "#/definitions/CloningInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If specified during app creation, the app is cloned from a source app." - }, - "snapshotInfo": { - "oneOf": [ - { - "$ref": "#/definitions/SnapshotRecoveryRequest" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If specified during app creation, the app is created from a previous snapshot." - }, - "httpsOnly": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests" - } - }, - "description": "Site resource specific properties" - }, - "sites_deployments_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "deployments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DeploymentProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Deployment resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/deployments" - }, - "sites_domainOwnershipIdentifiers_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "domainOwnershipIdentifiers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IdentifierProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/domainOwnershipIdentifiers" - }, - "sites_functions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "functions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FunctionEnvelopeProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "FunctionEnvelope resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/functions" - }, - "sites_hostNameBindings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "hostNameBindings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/HostNameBindingProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HostNameBinding resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/hostNameBindings" - }, - "sites_hybridconnection_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "hybridconnection" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelayServiceConnectionEntityProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "RelayServiceConnectionEntity resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/hybridconnection" - }, - "sites_premieraddons_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "premieraddons" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PremierAddOnProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PremierAddOn resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/sites/premieraddons" - }, - "sites_publicCertificates_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "publicCertificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicCertificateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PublicCertificate resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/publicCertificates" - }, - "sites_siteextensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "siteextensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Web/sites/siteextensions" - }, - "sites_slots_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "slots" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SiteProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Site resource specific properties" - }, - "identity": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedServiceIdentity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/sites/slots" - }, - "sites_slots_deployments_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "deployments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/DeploymentProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Deployment resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/deployments" - }, - "sites_slots_domainOwnershipIdentifiers_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "domainOwnershipIdentifiers" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/IdentifierProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Identifier resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/domainOwnershipIdentifiers" - }, - "sites_slots_functions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "functions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/FunctionEnvelopeProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "FunctionEnvelope resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/functions" - }, - "sites_slots_hostNameBindings_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "hostNameBindings" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/HostNameBindingProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HostNameBinding resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/hostNameBindings" - }, - "sites_slots_hybridconnection_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "hybridconnection" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/RelayServiceConnectionEntityProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "RelayServiceConnectionEntity resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/hybridconnection" - }, - "sites_slots_premieraddons_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "premieraddons" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PremierAddOnProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PremierAddOn resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/sites/slots/premieraddons" - }, - "sites_slots_publicCertificates_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "publicCertificates" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/PublicCertificateProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "PublicCertificate resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/publicCertificates" - }, - "sites_slots_siteextensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "siteextensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - } - }, - "required": [ - "name", - "type", - "apiVersion" - ], - "description": "Microsoft.Web/sites/slots/siteextensions" - }, - "sites_slots_virtualNetworkConnections_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkConnections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetInfoProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetInfo resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/virtualNetworkConnections" - }, - "sites_slots_virtualNetworkConnections_gateways_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "gateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetGatewayProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetGateway resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways" - }, - "sites_virtualNetworkConnections_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualNetworkConnections" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetInfoProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetInfo resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/virtualNetworkConnections" - }, - "sites_virtualNetworkConnections_gateways_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "gateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-08-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetGatewayProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetGateway resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/sites/virtualNetworkConnections/gateways" - }, - "SlowRequestsBasedTrigger": { - "type": "object", - "properties": { - "timeTaken": { - "type": "string", - "description": "Time taken." - }, - "count": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request Count." - }, - "timeInterval": { - "type": "string", - "description": "Time interval." - } - }, - "description": "Trigger based on request execution time." - }, - "SnapshotRecoveryRequest": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/SnapshotRecoveryRequestProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "SnapshotRecoveryRequest resource specific properties" - } - }, - "description": "Details about app recovery operation." - }, - "SnapshotRecoveryRequestProperties": { - "type": "object", - "properties": { - "snapshotTime": { - "type": "string", - "description": "Point in time in which the app recovery should be attempted, formatted as a DateTime string." - }, - "recoveryTarget": { - "oneOf": [ - { - "$ref": "#/definitions/SnapshotRecoveryTarget" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies the web app that snapshot contents will be written to." - }, - "overwrite": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If true the recovery operation can overwrite source app; otherwise, false." - }, - "recoverConfiguration": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If true, site configuration, in addition to content, will be reverted." - }, - "ignoreConflictingHostNames": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "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." - } - }, - "required": [ - "overwrite" - ], - "description": "SnapshotRecoveryRequest resource specific properties" - }, - "SnapshotRecoveryTarget": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS" - }, - "id": { - "type": "string", - "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." - } - }, - "description": "Specifies the web app that snapshot contents will be written to." - }, - "StatusCodesBasedTrigger": { - "type": "object", - "properties": { - "status": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "HTTP status code." - }, - "subStatus": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request Sub Status." - }, - "win32Status": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Win32 error code." - }, - "count": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Request Count." - }, - "timeInterval": { - "type": "string", - "description": "Time interval." - } - }, - "description": "Trigger based on status code." - }, - "VirtualApplication": { - "type": "object", - "properties": { - "virtualPath": { - "type": "string", - "description": "Virtual path." - }, - "physicalPath": { - "type": "string", - "description": "Physical path." - }, - "preloadEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "true if preloading is enabled; otherwise, false." - }, - "virtualDirectories": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualDirectory" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Virtual directories for virtual application." - } - }, - "description": "Virtual application in an app." - }, - "VirtualDirectory": { - "type": "object", - "properties": { - "virtualPath": { - "type": "string", - "description": "Path to virtual application." - }, - "physicalPath": { - "type": "string", - "description": "Physical path." - } - }, - "description": "Directory for virtual application." - }, - "VnetGatewayProperties": { - "type": "object", - "properties": { - "vnetName": { - "type": "string", - "description": "The Virtual Network name." - }, - "vpnPackageUri": { - "type": "string", - "description": "The URI where the VPN package can be downloaded." - } - }, - "required": [ - "vpnPackageUri" - ], - "description": "VnetGateway resource specific properties" - }, - "VnetInfoProperties": { - "type": "object", - "properties": { - "vnetResourceId": { - "type": "string", - "description": "The Virtual Network's resource ID." - }, - "certBlob": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "integer" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection." - }, - "dnsServers": { - "type": "string", - "description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses." - } - }, - "description": "VnetInfo resource specific properties" - } - } -} diff --git a/test/Resource/Expected/Web/2016-08-01/sites.md b/test/Resource/Expected/Web/2016-08-01/sites.md deleted file mode 100644 index e238430..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites.md +++ /dev/null @@ -1,546 +0,0 @@ -# Microsoft.Web/sites template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites", - "apiVersion": "2016-08-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "enabled": "boolean", - "hostNameSslStates": [ - { - "name": "string", - "sslState": "string", - "virtualIP": "string", - "thumbprint": "string", - "toUpdate": "boolean", - "hostType": "string" - } - ], - "serverFarmId": "string", - "reserved": "boolean", - "siteConfig": { - "numberOfWorkers": "integer", - "defaultDocuments": [ - "string" - ], - "netFrameworkVersion": "string", - "phpVersion": "string", - "pythonVersion": "string", - "nodeVersion": "string", - "linuxFxVersion": "string", - "requestTracingEnabled": "boolean", - "requestTracingExpirationTime": "string", - "remoteDebuggingEnabled": "boolean", - "remoteDebuggingVersion": "string", - "httpLoggingEnabled": "boolean", - "logsDirectorySizeLimit": "integer", - "detailedErrorLoggingEnabled": "boolean", - "publishingUsername": "string", - "appSettings": [ - { - "name": "string", - "value": "string" - } - ], - "connectionStrings": [ - { - "name": "string", - "connectionString": "string", - "type": "string" - } - ], - "handlerMappings": [ - { - "extension": "string", - "scriptProcessor": "string", - "arguments": "string" - } - ], - "documentRoot": "string", - "scmType": "string", - "use32BitWorkerProcess": "boolean", - "webSocketsEnabled": "boolean", - "alwaysOn": "boolean", - "javaVersion": "string", - "javaContainer": "string", - "javaContainerVersion": "string", - "appCommandLine": "string", - "managedPipelineMode": "string", - "virtualApplications": [ - { - "virtualPath": "string", - "physicalPath": "string", - "preloadEnabled": "boolean", - "virtualDirectories": [ - { - "virtualPath": "string", - "physicalPath": "string" - } - ] - } - ], - "loadBalancing": "string", - "experiments": { - "rampUpRules": [ - { - "actionHostName": "string", - "reroutePercentage": "number", - "changeStep": "number", - "changeIntervalInMinutes": "integer", - "minReroutePercentage": "number", - "maxReroutePercentage": "number", - "changeDecisionCallbackUrl": "string", - "name": "string" - } - ] - }, - "limits": { - "maxPercentageCpu": "number", - "maxMemoryInMb": "integer", - "maxDiskSizeInMb": "integer" - }, - "autoHealEnabled": "boolean", - "autoHealRules": { - "triggers": { - "requests": { - "count": "integer", - "timeInterval": "string" - }, - "privateBytesInKB": "integer", - "statusCodes": [ - { - "status": "integer", - "subStatus": "integer", - "win32Status": "integer", - "count": "integer", - "timeInterval": "string" - } - ], - "slowRequests": { - "timeTaken": "string", - "count": "integer", - "timeInterval": "string" - } - }, - "actions": { - "actionType": "string", - "customAction": { - "exe": "string", - "parameters": "string" - }, - "minProcessExecutionTime": "string" - } - }, - "tracingOptions": "string", - "vnetName": "string", - "cors": { - "allowedOrigins": [ - "string" - ] - }, - "push": { - "kind": "string", - "properties": { - "isPushEnabled": "boolean", - "tagWhitelistJson": "string", - "tagsRequiringAuth": "string", - "dynamicTagsJson": "string" - } - }, - "apiDefinition": { - "url": "string" - }, - "autoSwapSlotName": "string", - "localMySqlEnabled": "boolean", - "ipSecurityRestrictions": [ - { - "ipAddress": "string", - "subnetMask": "string" - } - ] - }, - "scmSiteAlsoStopped": "boolean", - "hostingEnvironmentProfile": { - "id": "string" - }, - "clientAffinityEnabled": "boolean", - "clientCertEnabled": "boolean", - "hostNamesDisabled": "boolean", - "containerSize": "integer", - "dailyMemoryTimeQuota": "integer", - "cloningInfo": { - "correlationId": "string", - "overwrite": "boolean", - "cloneCustomHostNames": "boolean", - "cloneSourceControl": "boolean", - "sourceWebAppId": "string", - "hostingEnvironment": "string", - "appSettingsOverrides": {}, - "configureLoadBalancing": "boolean", - "trafficManagerProfileId": "string", - "trafficManagerProfileName": "string", - "ignoreQuotas": "boolean" - }, - "snapshotInfo": { - "kind": "string", - "properties": { - "snapshotTime": "string", - "recoveryTarget": { - "location": "string", - "id": "string" - }, - "overwrite": "boolean", - "recoverConfiguration": "boolean", - "ignoreConflictingHostNames": "boolean" - } - }, - "httpsOnly": "boolean" - }, - "identity": { - "type": {} - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Site resource specific properties - [SiteProperties object](#SiteProperties) | -| identity | object | No | [ManagedServiceIdentity object](#ManagedServiceIdentity) | -| resources | array | No | [virtualNetworkConnections](./sites/virtualNetworkConnections.md) [slots](./sites/slots.md) [siteextensions](./sites/siteextensions.md) [publicCertificates](./sites/publicCertificates.md) [premieraddons](./sites/premieraddons.md) [hybridconnection](./sites/hybridconnection.md) [hostNameBindings](./sites/hostNameBindings.md) [functions](./sites/functions.md) [domainOwnershipIdentifiers](./sites/domainOwnershipIdentifiers.md) [deployments](./sites/deployments.md) | - - - -### SiteProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). | -| hostNameSslStates | array | No | Hostname SSL states are used to manage the SSL bindings for app's hostnames. - [HostNameSslState object](#HostNameSslState) | -| serverFarmId | string | No | Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". | -| reserved | boolean | No | true if reserved; otherwise, false. | -| siteConfig | object | No | Configuration of the app. - [SiteConfig object](#SiteConfig) | -| scmSiteAlsoStopped | boolean | No | true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. | -| hostingEnvironmentProfile | object | No | App Service Environment to use for the app. - [HostingEnvironmentProfile object](#HostingEnvironmentProfile) | -| clientAffinityEnabled | boolean | No | 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 | boolean | No | true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. | -| hostNamesDisabled | boolean | No | true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. | -| containerSize | integer | No | Size of the function container. | -| dailyMemoryTimeQuota | integer | No | Maximum allowed daily memory-time quota (applicable on dynamic apps only). | -| cloningInfo | object | No | If specified during app creation, the app is cloned from a source app. - [CloningInfo object](#CloningInfo) | -| snapshotInfo | object | No | If specified during app creation, the app is created from a previous snapshot. - [SnapshotRecoveryRequest object](#SnapshotRecoveryRequest) | -| httpsOnly | boolean | No | HttpsOnly: configures a web site to accept only https requests. Issues redirect forhttp requests | - - - -### ManagedServiceIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | object | No | Type of managed service identity. | - - - -### HostNameSslState object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Hostname. | -| sslState | enum | No | SSL type. - Disabled, SniEnabled, IpBasedEnabled | -| virtualIP | string | No | Virtual IP address assigned to the hostname if IP based SSL is enabled. | -| thumbprint | string | No | SSL certificate thumbprint. | -| toUpdate | boolean | No | Set to true to update existing hostname. | -| hostType | enum | No | Indicates whether the hostname is a standard or repository hostname. - Standard or Repository | - - - -### SiteConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| numberOfWorkers | integer | No | Number of workers. | -| defaultDocuments | array | No | Default documents. - string | -| netFrameworkVersion | string | No | .NET Framework version. | -| phpVersion | string | No | Version of PHP. | -| pythonVersion | string | No | Version of Python. | -| nodeVersion | string | No | Version of Node.js. | -| linuxFxVersion | string | No | Linux App Framework and version | -| requestTracingEnabled | boolean | No | true if request tracing is enabled; otherwise, false. | -| requestTracingExpirationTime | string | No | Request tracing expiration time. | -| remoteDebuggingEnabled | boolean | No | true if remote debugging is enabled; otherwise, false. | -| remoteDebuggingVersion | string | No | Remote debugging version. | -| httpLoggingEnabled | boolean | No | true if HTTP logging is enabled; otherwise, false. | -| logsDirectorySizeLimit | integer | No | HTTP logs directory size limit. | -| detailedErrorLoggingEnabled | boolean | No | true if detailed error logging is enabled; otherwise, false. | -| publishingUsername | string | No | Publishing user name. | -| appSettings | array | No | Application settings. - [NameValuePair object](#NameValuePair) | -| connectionStrings | array | No | Connection strings. - [ConnStringInfo object](#ConnStringInfo) | -| handlerMappings | array | No | Handler mappings. - [HandlerMapping object](#HandlerMapping) | -| documentRoot | string | No | Document root. | -| scmType | enum | No | SCM type. - None, Dropbox, Tfs, LocalGit, GitHub, CodePlexGit, CodePlexHg, BitbucketGit, BitbucketHg, ExternalGit, ExternalHg, OneDrive, VSO | -| use32BitWorkerProcess | boolean | No | true to use 32-bit worker process; otherwise, false. | -| webSocketsEnabled | boolean | No | true if WebSocket is enabled; otherwise, false. | -| alwaysOn | boolean | No | true if Always On is enabled; otherwise, false. | -| javaVersion | string | No | Java version. | -| javaContainer | string | No | Java container. | -| javaContainerVersion | string | No | Java container version. | -| appCommandLine | string | No | App command line to launch. | -| managedPipelineMode | enum | No | Managed pipeline mode. - Integrated or Classic | -| virtualApplications | array | No | Virtual applications. - [VirtualApplication object](#VirtualApplication) | -| loadBalancing | enum | No | Site load balancing. - WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash | -| experiments | object | No | This is work around for polymophic types. - [Experiments object](#Experiments) | -| limits | object | No | Site limits. - [SiteLimits object](#SiteLimits) | -| autoHealEnabled | boolean | No | true if Auto Heal is enabled; otherwise, false. | -| autoHealRules | object | No | Auto Heal rules. - [AutoHealRules object](#AutoHealRules) | -| tracingOptions | string | No | Tracing options. | -| vnetName | string | No | Virtual Network name. | -| cors | object | No | Cross-Origin Resource Sharing (CORS) settings. - [CorsSettings object](#CorsSettings) | -| push | object | No | Push endpoint settings. - [PushSettings object](#PushSettings) | -| apiDefinition | object | No | Information about the formal API definition for the app. - [ApiDefinitionInfo object](#ApiDefinitionInfo) | -| autoSwapSlotName | string | No | Auto-swap slot name. | -| localMySqlEnabled | boolean | No | true to enable local MySQL; otherwise, false. | -| ipSecurityRestrictions | array | No | IP security restrictions. - [IpSecurityRestriction object](#IpSecurityRestriction) | - - - -### HostingEnvironmentProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID of the App Service Environment. | - - - -### CloningInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| correlationId | string | No | Correlation ID of cloning operation. This ID ties multiple cloning operationstogether to use the same snapshot. - globally unique identifier | -| overwrite | boolean | No | true to overwrite destination app; otherwise, false. | -| cloneCustomHostNames | boolean | No | true to clone custom hostnames from source app; otherwise, false. | -| cloneSourceControl | boolean | No | true to clone source control from source app; otherwise, false. | -| sourceWebAppId | string | Yes | 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. | -| hostingEnvironment | string | No | App Service Environment. | -| appSettingsOverrides | object | No | 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. | -| configureLoadBalancing | boolean | No | true to configure load balancing for source and destination app. | -| trafficManagerProfileId | string | No | 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 | No | Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. | -| ignoreQuotas | boolean | No | true if quotas should be ignored; otherwise, false. | - - - -### SnapshotRecoveryRequest object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| kind | string | No | Kind of resource. | -| properties | object | No | SnapshotRecoveryRequest resource specific properties - [SnapshotRecoveryRequestProperties object](#SnapshotRecoveryRequestProperties) | - - - -### NameValuePair object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Pair name. | -| value | string | No | Pair value. | - - - -### ConnStringInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Name of connection string. | -| connectionString | string | No | Connection string value. | -| type | enum | No | Type of database. - MySql, SQLServer, SQLAzure, Custom, NotificationHub, ServiceBus, EventHub, ApiHub, DocDb, RedisCache, PostgreSQL | - - - -### HandlerMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| extension | string | No | Requests with this extension will be handled using the specified FastCGI application. | -| scriptProcessor | string | No | The absolute path to the FastCGI application. | -| arguments | string | No | Command-line arguments to be passed to the script processor. | - - - -### VirtualApplication object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualPath | string | No | Virtual path. | -| physicalPath | string | No | Physical path. | -| preloadEnabled | boolean | No | true if preloading is enabled; otherwise, false. | -| virtualDirectories | array | No | Virtual directories for virtual application. - [VirtualDirectory object](#VirtualDirectory) | - - - -### Experiments object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rampUpRules | array | No | List of ramp-up rules. - [RampUpRule object](#RampUpRule) | - - - -### SiteLimits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maxPercentageCpu | number | No | Maximum allowed CPU usage percentage. | -| maxMemoryInMb | integer | No | Maximum allowed memory usage in MB. | -| maxDiskSizeInMb | integer | No | Maximum allowed disk size usage in MB. | - - - -### AutoHealRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| triggers | object | No | Conditions that describe when to execute the auto-heal actions. - [AutoHealTriggers object](#AutoHealTriggers) | -| actions | object | No | Actions to be executed when a rule is triggered. - [AutoHealActions object](#AutoHealActions) | - - - -### CorsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowedOrigins | array | No | Gets or sets the list of origins that should be allowed to make cross-origincalls (for example: http://example.com:12345). Use "*" to allow all. - string | - - - -### PushSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| kind | string | No | Kind of resource. | -| properties | object | No | PushSettings resource specific properties - [PushSettingsProperties object](#PushSettingsProperties) | - - - -### ApiDefinitionInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| url | string | No | The URL of the API definition. | - - - -### IpSecurityRestriction object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipAddress | string | Yes | IP address the security restriction is valid for. | -| subnetMask | string | No | Subnet mask for the range of IP addresses the restriction is valid for. | - - - -### SnapshotRecoveryRequestProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| snapshotTime | string | No | Point in time in which the app recovery should be attempted, formatted as a DateTime string. | -| recoveryTarget | object | No | Specifies the web app that snapshot contents will be written to. - [SnapshotRecoveryTarget object](#SnapshotRecoveryTarget) | -| overwrite | boolean | Yes | If true the recovery operation can overwrite source app; otherwise, false. | -| recoverConfiguration | boolean | No | If true, site configuration, in addition to content, will be reverted. | -| ignoreConflictingHostNames | boolean | No | If true, custom hostname conflicts will be ignored when recovering to a target web app.This setting is only necessary when RecoverConfiguration is enabled. | - - - -### VirtualDirectory object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualPath | string | No | Path to virtual application. | -| physicalPath | string | No | Physical path. | - - - -### RampUpRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| actionHostName | string | No | Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. | -| reroutePercentage | number | No | Percentage of the traffic which will be redirected to ActionHostName. | -| changeStep | number | No | In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. | -| changeIntervalInMinutes | integer | No | Specifies interval in mimuntes to reevaluate ReroutePercentage. | -| minReroutePercentage | number | No | Specifies lower boundary above which ReroutePercentage will stay. | -| maxReroutePercentage | number | No | Specifies upper boundary below which ReroutePercentage will stay. | -| changeDecisionCallbackUrl | string | No | 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/ | -| name | string | No | Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. | - - - -### AutoHealTriggers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| requests | object | No | A rule based on total requests. - [RequestsBasedTrigger object](#RequestsBasedTrigger) | -| privateBytesInKB | integer | No | A rule based on private bytes. | -| statusCodes | array | No | A rule based on status codes. - [StatusCodesBasedTrigger object](#StatusCodesBasedTrigger) | -| slowRequests | object | No | A rule based on request execution time. - [SlowRequestsBasedTrigger object](#SlowRequestsBasedTrigger) | - - - -### AutoHealActions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| actionType | enum | No | Predefined action to be taken. - Recycle, LogEvent, CustomAction | -| customAction | object | No | Custom action to be taken. - [AutoHealCustomAction object](#AutoHealCustomAction) | -| minProcessExecutionTime | string | No | Minimum time the process must executebefore taking the action | - - - -### PushSettingsProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| isPushEnabled | boolean | Yes | Gets or sets a flag indicating whether the Push endpoint is enabled. | -| tagWhitelistJson | string | No | Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. | -| tagsRequiringAuth | string | No | 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. | -| dynamicTagsJson | string | No | Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. | - - - -### SnapshotRecoveryTarget object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| location | string | No | Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS | -| id | string | No | 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. | - - - -### RequestsBasedTrigger object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| count | integer | No | Request Count. | -| timeInterval | string | No | Time interval. | - - - -### StatusCodesBasedTrigger object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | integer | No | HTTP status code. | -| subStatus | integer | No | Request Sub Status. | -| win32Status | integer | No | Win32 error code. | -| count | integer | No | Request Count. | -| timeInterval | string | No | Time interval. | - - - -### SlowRequestsBasedTrigger object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| timeTaken | string | No | Time taken. | -| count | integer | No | Request Count. | -| timeInterval | string | No | Time interval. | - - - -### AutoHealCustomAction object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| exe | string | No | Executable to be run. | -| parameters | string | No | Parameters for the executable. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/deployments.md b/test/Resource/Expected/Web/2016-08-01/sites/deployments.md deleted file mode 100644 index e73a7d4..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/deployments.md +++ /dev/null @@ -1,56 +0,0 @@ -# Microsoft.Web/sites/deployments template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/deployments resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/deployments", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "id": "string", - "status": "integer", - "message": "string", - "author": "string", - "deployer": "string", - "authorEmail": "string", - "startTime": "string", - "endTime": "string", - "active": "boolean", - "details": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/deployments object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/deployments | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | Deployment resource specific properties - [DeploymentProperties object](#DeploymentProperties) | - - - -### DeploymentProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Identifier for deployment. | -| status | integer | No | Deployment status. | -| message | string | No | Details about deployment status. | -| author | string | No | Who authored the deployment. | -| deployer | string | No | Who performed the deployment. | -| authorEmail | string | No | Author email. | -| startTime | string | No | Start time. | -| endTime | string | No | End time. | -| active | boolean | No | True if deployment is currently active, false if completed and null if not started. | -| details | string | No | Details on deployment. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/domainOwnershipIdentifiers.md b/test/Resource/Expected/Web/2016-08-01/sites/domainOwnershipIdentifiers.md deleted file mode 100644 index c8c6efe..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/domainOwnershipIdentifiers.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.Web/sites/domainOwnershipIdentifiers template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/domainOwnershipIdentifiers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/domainOwnershipIdentifiers", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "id": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/domainOwnershipIdentifiers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/domainOwnershipIdentifiers | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | Identifier resource specific properties - [IdentifierProperties object](#IdentifierProperties) | - - - -### IdentifierProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | String representation of the identity. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/functions.md b/test/Resource/Expected/Web/2016-08-01/sites/functions.md deleted file mode 100644 index bcdadbd..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/functions.md +++ /dev/null @@ -1,52 +0,0 @@ -# Microsoft.Web/sites/functions template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/functions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/functions", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "scriptRootPathHref": "string", - "scriptHref": "string", - "configHref": "string", - "secretsFileHref": "string", - "href": "string", - "config": {}, - "files": {}, - "testData": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/functions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/functions | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | FunctionEnvelope resource specific properties - [FunctionEnvelopeProperties object](#FunctionEnvelopeProperties) | - - - -### FunctionEnvelopeProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| scriptRootPathHref | string | No | Script root path URI. | -| scriptHref | string | No | Script URI. | -| configHref | string | No | Config URI. | -| secretsFileHref | string | No | Secrets file URI. | -| href | string | No | Function URI. | -| config | object | No | Config information. | -| files | object | No | File list. | -| testData | string | No | Test data used when testing via the Azure Portal. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/hostNameBindings.md b/test/Resource/Expected/Web/2016-08-01/sites/hostNameBindings.md deleted file mode 100644 index f83932a..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/hostNameBindings.md +++ /dev/null @@ -1,52 +0,0 @@ -# Microsoft.Web/sites/hostNameBindings template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/hostNameBindings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/hostNameBindings", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "siteName": "string", - "domainId": "string", - "azureResourceName": "string", - "azureResourceType": "string", - "customHostNameDnsRecordType": "string", - "hostNameType": "string", - "sslState": "string", - "thumbprint": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/hostNameBindings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/hostNameBindings | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | HostNameBinding resource specific properties - [HostNameBindingProperties object](#HostNameBindingProperties) | - - - -### HostNameBindingProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| siteName | string | No | App Service app name. | -| domainId | string | No | Fully qualified ARM domain resource URI. | -| azureResourceName | string | No | Azure resource name. | -| azureResourceType | enum | No | Azure resource type. - Website or TrafficManager | -| customHostNameDnsRecordType | enum | No | Custom DNS record type. - CName or A | -| hostNameType | enum | No | Hostname type. - Verified or Managed | -| sslState | enum | No | SSL type. - Disabled, SniEnabled, IpBasedEnabled | -| thumbprint | string | No | SSL certificate thumbprint | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/hybridConnectionNamespaces/relays.md b/test/Resource/Expected/Web/2016-08-01/sites/hybridConnectionNamespaces/relays.md deleted file mode 100644 index 70f3018..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/hybridConnectionNamespaces/relays.md +++ /dev/null @@ -1,52 +0,0 @@ -# Microsoft.Web/sites/hybridConnectionNamespaces/relays template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/hybridConnectionNamespaces/relays resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/hybridConnectionNamespaces/relays", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "serviceBusNamespace": "string", - "relayName": "string", - "relayArmUri": "string", - "hostname": "string", - "port": "integer", - "sendKeyName": "string", - "sendKeyValue": "string", - "serviceBusSuffix": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/hybridConnectionNamespaces/relays object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/hybridConnectionNamespaces/relays | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | HybridConnection resource specific properties - [HybridConnectionProperties object](#HybridConnectionProperties) | - - - -### HybridConnectionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceBusNamespace | string | No | The name of the Service Bus namespace. | -| relayName | string | No | The name of the Service Bus relay. | -| relayArmUri | string | No | The ARM URI to the Service Bus relay. | -| hostname | string | No | The hostname of the endpoint. | -| port | integer | No | The port of the endpoint. | -| sendKeyName | string | No | The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. | -| sendKeyValue | string | No | The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returnednormally, use the POST /listKeys API instead. | -| serviceBusSuffix | string | No | The suffix for the service bus endpoint. By default this is .servicebus.windows.net | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/hybridconnection.md b/test/Resource/Expected/Web/2016-08-01/sites/hybridconnection.md deleted file mode 100644 index 9ffc78a..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/hybridconnection.md +++ /dev/null @@ -1,50 +0,0 @@ -# Microsoft.Web/sites/hybridconnection template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/hybridconnection resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/hybridconnection", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "entityName": "string", - "entityConnectionString": "string", - "resourceType": "string", - "resourceConnectionString": "string", - "hostname": "string", - "port": "integer", - "biztalkUri": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/hybridconnection object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/hybridconnection | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | RelayServiceConnectionEntity resource specific properties - [RelayServiceConnectionEntityProperties object](#RelayServiceConnectionEntityProperties) | - - - -### RelayServiceConnectionEntityProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| entityName | string | No | | -| entityConnectionString | string | No | | -| resourceType | string | No | | -| resourceConnectionString | string | No | | -| hostname | string | No | | -| port | integer | No | | -| biztalkUri | string | No | | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/premieraddons.md b/test/Resource/Expected/Web/2016-08-01/sites/premieraddons.md deleted file mode 100644 index a899505..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/premieraddons.md +++ /dev/null @@ -1,56 +0,0 @@ -# Microsoft.Web/sites/premieraddons template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/premieraddons resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/premieraddons", - "apiVersion": "2016-08-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": "string", - "product": "string", - "vendor": "string", - "name": "string", - "location": "string", - "tags": {}, - "marketplacePublisher": "string", - "marketplaceOffer": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/premieraddons object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/premieraddons | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | PremierAddOn resource specific properties - [PremierAddOnProperties object](#PremierAddOnProperties) | - - - -### PremierAddOnProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | string | No | Premier add on SKU. | -| product | string | No | Premier add on Product. | -| vendor | string | No | Premier add on Vendor. | -| name | string | No | Premier add on Name. | -| location | string | No | Premier add on Location. | -| tags | object | No | Premier add on Tags. | -| marketplacePublisher | string | No | Premier add on Marketplace publisher. | -| marketplaceOffer | string | No | Premier add on Marketplace offer. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/publicCertificates.md b/test/Resource/Expected/Web/2016-08-01/sites/publicCertificates.md deleted file mode 100644 index 46ac737..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/publicCertificates.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.Web/sites/publicCertificates template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/publicCertificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/publicCertificates", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "blob": [ - "integer" - ], - "publicCertificateLocation": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/publicCertificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/publicCertificates | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | PublicCertificate resource specific properties - [PublicCertificateProperties object](#PublicCertificateProperties) | - - - -### PublicCertificateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| blob | array | No | Public Certificate byte array - integer | -| publicCertificateLocation | enum | No | Public Certificate Location. - CurrentUserMy, LocalMachineMy, Unknown | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/siteextensions.md b/test/Resource/Expected/Web/2016-08-01/sites/siteextensions.md deleted file mode 100644 index 98ac5dd..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/siteextensions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.Web/sites/siteextensions template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/siteextensions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/siteextensions", - "apiVersion": "2016-08-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/siteextensions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/siteextensions | -| apiVersion | enum | Yes | 2016-08-01 | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots.md b/test/Resource/Expected/Web/2016-08-01/sites/slots.md deleted file mode 100644 index 243ea58..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots.md +++ /dev/null @@ -1,546 +0,0 @@ -# Microsoft.Web/sites/slots template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots", - "apiVersion": "2016-08-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "enabled": "boolean", - "hostNameSslStates": [ - { - "name": "string", - "sslState": "string", - "virtualIP": "string", - "thumbprint": "string", - "toUpdate": "boolean", - "hostType": "string" - } - ], - "serverFarmId": "string", - "reserved": "boolean", - "siteConfig": { - "numberOfWorkers": "integer", - "defaultDocuments": [ - "string" - ], - "netFrameworkVersion": "string", - "phpVersion": "string", - "pythonVersion": "string", - "nodeVersion": "string", - "linuxFxVersion": "string", - "requestTracingEnabled": "boolean", - "requestTracingExpirationTime": "string", - "remoteDebuggingEnabled": "boolean", - "remoteDebuggingVersion": "string", - "httpLoggingEnabled": "boolean", - "logsDirectorySizeLimit": "integer", - "detailedErrorLoggingEnabled": "boolean", - "publishingUsername": "string", - "appSettings": [ - { - "name": "string", - "value": "string" - } - ], - "connectionStrings": [ - { - "name": "string", - "connectionString": "string", - "type": "string" - } - ], - "handlerMappings": [ - { - "extension": "string", - "scriptProcessor": "string", - "arguments": "string" - } - ], - "documentRoot": "string", - "scmType": "string", - "use32BitWorkerProcess": "boolean", - "webSocketsEnabled": "boolean", - "alwaysOn": "boolean", - "javaVersion": "string", - "javaContainer": "string", - "javaContainerVersion": "string", - "appCommandLine": "string", - "managedPipelineMode": "string", - "virtualApplications": [ - { - "virtualPath": "string", - "physicalPath": "string", - "preloadEnabled": "boolean", - "virtualDirectories": [ - { - "virtualPath": "string", - "physicalPath": "string" - } - ] - } - ], - "loadBalancing": "string", - "experiments": { - "rampUpRules": [ - { - "actionHostName": "string", - "reroutePercentage": "number", - "changeStep": "number", - "changeIntervalInMinutes": "integer", - "minReroutePercentage": "number", - "maxReroutePercentage": "number", - "changeDecisionCallbackUrl": "string", - "name": "string" - } - ] - }, - "limits": { - "maxPercentageCpu": "number", - "maxMemoryInMb": "integer", - "maxDiskSizeInMb": "integer" - }, - "autoHealEnabled": "boolean", - "autoHealRules": { - "triggers": { - "requests": { - "count": "integer", - "timeInterval": "string" - }, - "privateBytesInKB": "integer", - "statusCodes": [ - { - "status": "integer", - "subStatus": "integer", - "win32Status": "integer", - "count": "integer", - "timeInterval": "string" - } - ], - "slowRequests": { - "timeTaken": "string", - "count": "integer", - "timeInterval": "string" - } - }, - "actions": { - "actionType": "string", - "customAction": { - "exe": "string", - "parameters": "string" - }, - "minProcessExecutionTime": "string" - } - }, - "tracingOptions": "string", - "vnetName": "string", - "cors": { - "allowedOrigins": [ - "string" - ] - }, - "push": { - "kind": "string", - "properties": { - "isPushEnabled": "boolean", - "tagWhitelistJson": "string", - "tagsRequiringAuth": "string", - "dynamicTagsJson": "string" - } - }, - "apiDefinition": { - "url": "string" - }, - "autoSwapSlotName": "string", - "localMySqlEnabled": "boolean", - "ipSecurityRestrictions": [ - { - "ipAddress": "string", - "subnetMask": "string" - } - ] - }, - "scmSiteAlsoStopped": "boolean", - "hostingEnvironmentProfile": { - "id": "string" - }, - "clientAffinityEnabled": "boolean", - "clientCertEnabled": "boolean", - "hostNamesDisabled": "boolean", - "containerSize": "integer", - "dailyMemoryTimeQuota": "integer", - "cloningInfo": { - "correlationId": "string", - "overwrite": "boolean", - "cloneCustomHostNames": "boolean", - "cloneSourceControl": "boolean", - "sourceWebAppId": "string", - "hostingEnvironment": "string", - "appSettingsOverrides": {}, - "configureLoadBalancing": "boolean", - "trafficManagerProfileId": "string", - "trafficManagerProfileName": "string", - "ignoreQuotas": "boolean" - }, - "snapshotInfo": { - "kind": "string", - "properties": { - "snapshotTime": "string", - "recoveryTarget": { - "location": "string", - "id": "string" - }, - "overwrite": "boolean", - "recoverConfiguration": "boolean", - "ignoreConflictingHostNames": "boolean" - } - }, - "httpsOnly": "boolean" - }, - "identity": { - "type": {} - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Site resource specific properties - [SiteProperties object](#SiteProperties) | -| identity | object | No | [ManagedServiceIdentity object](#ManagedServiceIdentity) | -| resources | array | No | [virtualNetworkConnections](./slots/virtualNetworkConnections.md) [siteextensions](./slots/siteextensions.md) [publicCertificates](./slots/publicCertificates.md) [premieraddons](./slots/premieraddons.md) [hybridconnection](./slots/hybridconnection.md) [hostNameBindings](./slots/hostNameBindings.md) [functions](./slots/functions.md) [domainOwnershipIdentifiers](./slots/domainOwnershipIdentifiers.md) [deployments](./slots/deployments.md) | - - - -### SiteProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| enabled | boolean | No | true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). | -| hostNameSslStates | array | No | Hostname SSL states are used to manage the SSL bindings for app's hostnames. - [HostNameSslState object](#HostNameSslState) | -| serverFarmId | string | No | Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". | -| reserved | boolean | No | true if reserved; otherwise, false. | -| siteConfig | object | No | Configuration of the app. - [SiteConfig object](#SiteConfig) | -| scmSiteAlsoStopped | boolean | No | true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. | -| hostingEnvironmentProfile | object | No | App Service Environment to use for the app. - [HostingEnvironmentProfile object](#HostingEnvironmentProfile) | -| clientAffinityEnabled | boolean | No | 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 | boolean | No | true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. | -| hostNamesDisabled | boolean | No | true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. | -| containerSize | integer | No | Size of the function container. | -| dailyMemoryTimeQuota | integer | No | Maximum allowed daily memory-time quota (applicable on dynamic apps only). | -| cloningInfo | object | No | If specified during app creation, the app is cloned from a source app. - [CloningInfo object](#CloningInfo) | -| snapshotInfo | object | No | If specified during app creation, the app is created from a previous snapshot. - [SnapshotRecoveryRequest object](#SnapshotRecoveryRequest) | -| httpsOnly | boolean | No | HttpsOnly: configures a web site to accept only https requests. Issues redirect forhttp requests | - - - -### ManagedServiceIdentity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| type | object | No | Type of managed service identity. | - - - -### HostNameSslState object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Hostname. | -| sslState | enum | No | SSL type. - Disabled, SniEnabled, IpBasedEnabled | -| virtualIP | string | No | Virtual IP address assigned to the hostname if IP based SSL is enabled. | -| thumbprint | string | No | SSL certificate thumbprint. | -| toUpdate | boolean | No | Set to true to update existing hostname. | -| hostType | enum | No | Indicates whether the hostname is a standard or repository hostname. - Standard or Repository | - - - -### SiteConfig object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| numberOfWorkers | integer | No | Number of workers. | -| defaultDocuments | array | No | Default documents. - string | -| netFrameworkVersion | string | No | .NET Framework version. | -| phpVersion | string | No | Version of PHP. | -| pythonVersion | string | No | Version of Python. | -| nodeVersion | string | No | Version of Node.js. | -| linuxFxVersion | string | No | Linux App Framework and version | -| requestTracingEnabled | boolean | No | true if request tracing is enabled; otherwise, false. | -| requestTracingExpirationTime | string | No | Request tracing expiration time. | -| remoteDebuggingEnabled | boolean | No | true if remote debugging is enabled; otherwise, false. | -| remoteDebuggingVersion | string | No | Remote debugging version. | -| httpLoggingEnabled | boolean | No | true if HTTP logging is enabled; otherwise, false. | -| logsDirectorySizeLimit | integer | No | HTTP logs directory size limit. | -| detailedErrorLoggingEnabled | boolean | No | true if detailed error logging is enabled; otherwise, false. | -| publishingUsername | string | No | Publishing user name. | -| appSettings | array | No | Application settings. - [NameValuePair object](#NameValuePair) | -| connectionStrings | array | No | Connection strings. - [ConnStringInfo object](#ConnStringInfo) | -| handlerMappings | array | No | Handler mappings. - [HandlerMapping object](#HandlerMapping) | -| documentRoot | string | No | Document root. | -| scmType | enum | No | SCM type. - None, Dropbox, Tfs, LocalGit, GitHub, CodePlexGit, CodePlexHg, BitbucketGit, BitbucketHg, ExternalGit, ExternalHg, OneDrive, VSO | -| use32BitWorkerProcess | boolean | No | true to use 32-bit worker process; otherwise, false. | -| webSocketsEnabled | boolean | No | true if WebSocket is enabled; otherwise, false. | -| alwaysOn | boolean | No | true if Always On is enabled; otherwise, false. | -| javaVersion | string | No | Java version. | -| javaContainer | string | No | Java container. | -| javaContainerVersion | string | No | Java container version. | -| appCommandLine | string | No | App command line to launch. | -| managedPipelineMode | enum | No | Managed pipeline mode. - Integrated or Classic | -| virtualApplications | array | No | Virtual applications. - [VirtualApplication object](#VirtualApplication) | -| loadBalancing | enum | No | Site load balancing. - WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash | -| experiments | object | No | This is work around for polymophic types. - [Experiments object](#Experiments) | -| limits | object | No | Site limits. - [SiteLimits object](#SiteLimits) | -| autoHealEnabled | boolean | No | true if Auto Heal is enabled; otherwise, false. | -| autoHealRules | object | No | Auto Heal rules. - [AutoHealRules object](#AutoHealRules) | -| tracingOptions | string | No | Tracing options. | -| vnetName | string | No | Virtual Network name. | -| cors | object | No | Cross-Origin Resource Sharing (CORS) settings. - [CorsSettings object](#CorsSettings) | -| push | object | No | Push endpoint settings. - [PushSettings object](#PushSettings) | -| apiDefinition | object | No | Information about the formal API definition for the app. - [ApiDefinitionInfo object](#ApiDefinitionInfo) | -| autoSwapSlotName | string | No | Auto-swap slot name. | -| localMySqlEnabled | boolean | No | true to enable local MySQL; otherwise, false. | -| ipSecurityRestrictions | array | No | IP security restrictions. - [IpSecurityRestriction object](#IpSecurityRestriction) | - - - -### HostingEnvironmentProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID of the App Service Environment. | - - - -### CloningInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| correlationId | string | No | Correlation ID of cloning operation. This ID ties multiple cloning operationstogether to use the same snapshot. - globally unique identifier | -| overwrite | boolean | No | true to overwrite destination app; otherwise, false. | -| cloneCustomHostNames | boolean | No | true to clone custom hostnames from source app; otherwise, false. | -| cloneSourceControl | boolean | No | true to clone source control from source app; otherwise, false. | -| sourceWebAppId | string | Yes | 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. | -| hostingEnvironment | string | No | App Service Environment. | -| appSettingsOverrides | object | No | 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. | -| configureLoadBalancing | boolean | No | true to configure load balancing for source and destination app. | -| trafficManagerProfileId | string | No | 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 | No | Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. | -| ignoreQuotas | boolean | No | true if quotas should be ignored; otherwise, false. | - - - -### SnapshotRecoveryRequest object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| kind | string | No | Kind of resource. | -| properties | object | No | SnapshotRecoveryRequest resource specific properties - [SnapshotRecoveryRequestProperties object](#SnapshotRecoveryRequestProperties) | - - - -### NameValuePair object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Pair name. | -| value | string | No | Pair value. | - - - -### ConnStringInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Name of connection string. | -| connectionString | string | No | Connection string value. | -| type | enum | No | Type of database. - MySql, SQLServer, SQLAzure, Custom, NotificationHub, ServiceBus, EventHub, ApiHub, DocDb, RedisCache, PostgreSQL | - - - -### HandlerMapping object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| extension | string | No | Requests with this extension will be handled using the specified FastCGI application. | -| scriptProcessor | string | No | The absolute path to the FastCGI application. | -| arguments | string | No | Command-line arguments to be passed to the script processor. | - - - -### VirtualApplication object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualPath | string | No | Virtual path. | -| physicalPath | string | No | Physical path. | -| preloadEnabled | boolean | No | true if preloading is enabled; otherwise, false. | -| virtualDirectories | array | No | Virtual directories for virtual application. - [VirtualDirectory object](#VirtualDirectory) | - - - -### Experiments object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| rampUpRules | array | No | List of ramp-up rules. - [RampUpRule object](#RampUpRule) | - - - -### SiteLimits object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| maxPercentageCpu | number | No | Maximum allowed CPU usage percentage. | -| maxMemoryInMb | integer | No | Maximum allowed memory usage in MB. | -| maxDiskSizeInMb | integer | No | Maximum allowed disk size usage in MB. | - - - -### AutoHealRules object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| triggers | object | No | Conditions that describe when to execute the auto-heal actions. - [AutoHealTriggers object](#AutoHealTriggers) | -| actions | object | No | Actions to be executed when a rule is triggered. - [AutoHealActions object](#AutoHealActions) | - - - -### CorsSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| allowedOrigins | array | No | Gets or sets the list of origins that should be allowed to make cross-origincalls (for example: http://example.com:12345). Use "*" to allow all. - string | - - - -### PushSettings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| kind | string | No | Kind of resource. | -| properties | object | No | PushSettings resource specific properties - [PushSettingsProperties object](#PushSettingsProperties) | - - - -### ApiDefinitionInfo object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| url | string | No | The URL of the API definition. | - - - -### IpSecurityRestriction object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| ipAddress | string | Yes | IP address the security restriction is valid for. | -| subnetMask | string | No | Subnet mask for the range of IP addresses the restriction is valid for. | - - - -### SnapshotRecoveryRequestProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| snapshotTime | string | No | Point in time in which the app recovery should be attempted, formatted as a DateTime string. | -| recoveryTarget | object | No | Specifies the web app that snapshot contents will be written to. - [SnapshotRecoveryTarget object](#SnapshotRecoveryTarget) | -| overwrite | boolean | Yes | If true the recovery operation can overwrite source app; otherwise, false. | -| recoverConfiguration | boolean | No | If true, site configuration, in addition to content, will be reverted. | -| ignoreConflictingHostNames | boolean | No | If true, custom hostname conflicts will be ignored when recovering to a target web app.This setting is only necessary when RecoverConfiguration is enabled. | - - - -### VirtualDirectory object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| virtualPath | string | No | Path to virtual application. | -| physicalPath | string | No | Physical path. | - - - -### RampUpRule object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| actionHostName | string | No | Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. | -| reroutePercentage | number | No | Percentage of the traffic which will be redirected to ActionHostName. | -| changeStep | number | No | In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. | -| changeIntervalInMinutes | integer | No | Specifies interval in mimuntes to reevaluate ReroutePercentage. | -| minReroutePercentage | number | No | Specifies lower boundary above which ReroutePercentage will stay. | -| maxReroutePercentage | number | No | Specifies upper boundary below which ReroutePercentage will stay. | -| changeDecisionCallbackUrl | string | No | 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/ | -| name | string | No | Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. | - - - -### AutoHealTriggers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| requests | object | No | A rule based on total requests. - [RequestsBasedTrigger object](#RequestsBasedTrigger) | -| privateBytesInKB | integer | No | A rule based on private bytes. | -| statusCodes | array | No | A rule based on status codes. - [StatusCodesBasedTrigger object](#StatusCodesBasedTrigger) | -| slowRequests | object | No | A rule based on request execution time. - [SlowRequestsBasedTrigger object](#SlowRequestsBasedTrigger) | - - - -### AutoHealActions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| actionType | enum | No | Predefined action to be taken. - Recycle, LogEvent, CustomAction | -| customAction | object | No | Custom action to be taken. - [AutoHealCustomAction object](#AutoHealCustomAction) | -| minProcessExecutionTime | string | No | Minimum time the process must executebefore taking the action | - - - -### PushSettingsProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| isPushEnabled | boolean | Yes | Gets or sets a flag indicating whether the Push endpoint is enabled. | -| tagWhitelistJson | string | No | Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. | -| tagsRequiringAuth | string | No | 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. | -| dynamicTagsJson | string | No | Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. | - - - -### SnapshotRecoveryTarget object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| location | string | No | Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS | -| id | string | No | 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. | - - - -### RequestsBasedTrigger object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| count | integer | No | Request Count. | -| timeInterval | string | No | Time interval. | - - - -### StatusCodesBasedTrigger object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| status | integer | No | HTTP status code. | -| subStatus | integer | No | Request Sub Status. | -| win32Status | integer | No | Win32 error code. | -| count | integer | No | Request Count. | -| timeInterval | string | No | Time interval. | - - - -### SlowRequestsBasedTrigger object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| timeTaken | string | No | Time taken. | -| count | integer | No | Request Count. | -| timeInterval | string | No | Time interval. | - - - -### AutoHealCustomAction object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| exe | string | No | Executable to be run. | -| parameters | string | No | Parameters for the executable. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/deployments.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/deployments.md deleted file mode 100644 index 1166a9a..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/deployments.md +++ /dev/null @@ -1,56 +0,0 @@ -# Microsoft.Web/sites/slots/deployments template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/deployments resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/deployments", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "id": "string", - "status": "integer", - "message": "string", - "author": "string", - "deployer": "string", - "authorEmail": "string", - "startTime": "string", - "endTime": "string", - "active": "boolean", - "details": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/deployments object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/deployments | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | Deployment resource specific properties - [DeploymentProperties object](#DeploymentProperties) | - - - -### DeploymentProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Identifier for deployment. | -| status | integer | No | Deployment status. | -| message | string | No | Details about deployment status. | -| author | string | No | Who authored the deployment. | -| deployer | string | No | Who performed the deployment. | -| authorEmail | string | No | Author email. | -| startTime | string | No | Start time. | -| endTime | string | No | End time. | -| active | boolean | No | True if deployment is currently active, false if completed and null if not started. | -| details | string | No | Details on deployment. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/domainOwnershipIdentifiers.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/domainOwnershipIdentifiers.md deleted file mode 100644 index 2a6cc70..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/domainOwnershipIdentifiers.md +++ /dev/null @@ -1,38 +0,0 @@ -# Microsoft.Web/sites/slots/domainOwnershipIdentifiers template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/domainOwnershipIdentifiers resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/domainOwnershipIdentifiers", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "id": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/domainOwnershipIdentifiers object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/domainOwnershipIdentifiers | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | Identifier resource specific properties - [IdentifierProperties object](#IdentifierProperties) | - - - -### IdentifierProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | String representation of the identity. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/functions.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/functions.md deleted file mode 100644 index 2d09a06..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/functions.md +++ /dev/null @@ -1,52 +0,0 @@ -# Microsoft.Web/sites/slots/functions template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/functions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/functions", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "scriptRootPathHref": "string", - "scriptHref": "string", - "configHref": "string", - "secretsFileHref": "string", - "href": "string", - "config": {}, - "files": {}, - "testData": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/functions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/functions | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | FunctionEnvelope resource specific properties - [FunctionEnvelopeProperties object](#FunctionEnvelopeProperties) | - - - -### FunctionEnvelopeProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| scriptRootPathHref | string | No | Script root path URI. | -| scriptHref | string | No | Script URI. | -| configHref | string | No | Config URI. | -| secretsFileHref | string | No | Secrets file URI. | -| href | string | No | Function URI. | -| config | object | No | Config information. | -| files | object | No | File list. | -| testData | string | No | Test data used when testing via the Azure Portal. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/hostNameBindings.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/hostNameBindings.md deleted file mode 100644 index edccf29..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/hostNameBindings.md +++ /dev/null @@ -1,52 +0,0 @@ -# Microsoft.Web/sites/slots/hostNameBindings template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/hostNameBindings resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/hostNameBindings", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "siteName": "string", - "domainId": "string", - "azureResourceName": "string", - "azureResourceType": "string", - "customHostNameDnsRecordType": "string", - "hostNameType": "string", - "sslState": "string", - "thumbprint": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/hostNameBindings object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/hostNameBindings | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | HostNameBinding resource specific properties - [HostNameBindingProperties object](#HostNameBindingProperties) | - - - -### HostNameBindingProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| siteName | string | No | App Service app name. | -| domainId | string | No | Fully qualified ARM domain resource URI. | -| azureResourceName | string | No | Azure resource name. | -| azureResourceType | enum | No | Azure resource type. - Website or TrafficManager | -| customHostNameDnsRecordType | enum | No | Custom DNS record type. - CName or A | -| hostNameType | enum | No | Hostname type. - Verified or Managed | -| sslState | enum | No | SSL type. - Disabled, SniEnabled, IpBasedEnabled | -| thumbprint | string | No | SSL certificate thumbprint | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/hybridConnectionNamespaces/relays.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/hybridConnectionNamespaces/relays.md deleted file mode 100644 index 346ffb7..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/hybridConnectionNamespaces/relays.md +++ /dev/null @@ -1,52 +0,0 @@ -# Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "serviceBusNamespace": "string", - "relayName": "string", - "relayArmUri": "string", - "hostname": "string", - "port": "integer", - "sendKeyName": "string", - "sendKeyValue": "string", - "serviceBusSuffix": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | HybridConnection resource specific properties - [HybridConnectionProperties object](#HybridConnectionProperties) | - - - -### HybridConnectionProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| serviceBusNamespace | string | No | The name of the Service Bus namespace. | -| relayName | string | No | The name of the Service Bus relay. | -| relayArmUri | string | No | The ARM URI to the Service Bus relay. | -| hostname | string | No | The hostname of the endpoint. | -| port | integer | No | The port of the endpoint. | -| sendKeyName | string | No | The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. | -| sendKeyValue | string | No | The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returnednormally, use the POST /listKeys API instead. | -| serviceBusSuffix | string | No | The suffix for the service bus endpoint. By default this is .servicebus.windows.net | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/hybridconnection.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/hybridconnection.md deleted file mode 100644 index 9d0eb2a..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/hybridconnection.md +++ /dev/null @@ -1,50 +0,0 @@ -# Microsoft.Web/sites/slots/hybridconnection template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/hybridconnection resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/hybridconnection", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "entityName": "string", - "entityConnectionString": "string", - "resourceType": "string", - "resourceConnectionString": "string", - "hostname": "string", - "port": "integer", - "biztalkUri": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/hybridconnection object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/hybridconnection | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | RelayServiceConnectionEntity resource specific properties - [RelayServiceConnectionEntityProperties object](#RelayServiceConnectionEntityProperties) | - - - -### RelayServiceConnectionEntityProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| entityName | string | No | | -| entityConnectionString | string | No | | -| resourceType | string | No | | -| resourceConnectionString | string | No | | -| hostname | string | No | | -| port | integer | No | | -| biztalkUri | string | No | | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/premieraddons.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/premieraddons.md deleted file mode 100644 index cb9eb2f..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/premieraddons.md +++ /dev/null @@ -1,56 +0,0 @@ -# Microsoft.Web/sites/slots/premieraddons template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/premieraddons resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/premieraddons", - "apiVersion": "2016-08-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "sku": "string", - "product": "string", - "vendor": "string", - "name": "string", - "location": "string", - "tags": {}, - "marketplacePublisher": "string", - "marketplaceOffer": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/premieraddons object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/premieraddons | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | PremierAddOn resource specific properties - [PremierAddOnProperties object](#PremierAddOnProperties) | - - - -### PremierAddOnProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| sku | string | No | Premier add on SKU. | -| product | string | No | Premier add on Product. | -| vendor | string | No | Premier add on Vendor. | -| name | string | No | Premier add on Name. | -| location | string | No | Premier add on Location. | -| tags | object | No | Premier add on Tags. | -| marketplacePublisher | string | No | Premier add on Marketplace publisher. | -| marketplaceOffer | string | No | Premier add on Marketplace offer. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/publicCertificates.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/publicCertificates.md deleted file mode 100644 index d423adb..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/publicCertificates.md +++ /dev/null @@ -1,42 +0,0 @@ -# Microsoft.Web/sites/slots/publicCertificates template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/publicCertificates resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/publicCertificates", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "blob": [ - "integer" - ], - "publicCertificateLocation": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/publicCertificates object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/publicCertificates | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | PublicCertificate resource specific properties - [PublicCertificateProperties object](#PublicCertificateProperties) | - - - -### PublicCertificateProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| blob | array | No | Public Certificate byte array - integer | -| publicCertificateLocation | enum | No | Public Certificate Location. - CurrentUserMy, LocalMachineMy, Unknown | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/siteextensions.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/siteextensions.md deleted file mode 100644 index d03233a..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/siteextensions.md +++ /dev/null @@ -1,25 +0,0 @@ -# Microsoft.Web/sites/slots/siteextensions template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/siteextensions resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/siteextensions", - "apiVersion": "2016-08-01" -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/siteextensions object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/siteextensions | -| apiVersion | enum | Yes | 2016-08-01 | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/virtualNetworkConnections.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/virtualNetworkConnections.md deleted file mode 100644 index b498203..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/virtualNetworkConnections.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Web/sites/slots/virtualNetworkConnections template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/virtualNetworkConnections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/virtualNetworkConnections", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "vnetResourceId": "string", - "certBlob": [ - "integer" - ], - "dnsServers": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/virtualNetworkConnections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/virtualNetworkConnections | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | VnetInfo resource specific properties - [VnetInfoProperties object](#VnetInfoProperties) | -| resources | array | No | [gateways](./virtualNetworkConnections/gateways.md) | - - - -### VnetInfoProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vnetResourceId | string | No | The Virtual Network's resource ID. | -| certBlob | array | No | A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. - integer | -| dnsServers | string | No | DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/slots/virtualNetworkConnections/gateways.md b/test/Resource/Expected/Web/2016-08-01/sites/slots/virtualNetworkConnections/gateways.md deleted file mode 100644 index e3353ed..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/slots/virtualNetworkConnections/gateways.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Web/sites/slots/virtualNetworkConnections/gateways template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/slots/virtualNetworkConnections/gateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "vnetName": "string", - "vpnPackageUri": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/slots/virtualNetworkConnections/gateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/slots/virtualNetworkConnections/gateways | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | VnetGateway resource specific properties - [VnetGatewayProperties object](#VnetGatewayProperties) | - - - -### VnetGatewayProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vnetName | string | No | The Virtual Network name. | -| vpnPackageUri | string | Yes | The URI where the VPN package can be downloaded. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/virtualNetworkConnections.md b/test/Resource/Expected/Web/2016-08-01/sites/virtualNetworkConnections.md deleted file mode 100644 index b530164..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/virtualNetworkConnections.md +++ /dev/null @@ -1,46 +0,0 @@ -# Microsoft.Web/sites/virtualNetworkConnections template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/virtualNetworkConnections resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/virtualNetworkConnections", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "vnetResourceId": "string", - "certBlob": [ - "integer" - ], - "dnsServers": "string" - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/virtualNetworkConnections object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/virtualNetworkConnections | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | VnetInfo resource specific properties - [VnetInfoProperties object](#VnetInfoProperties) | -| resources | array | No | [gateways](./virtualNetworkConnections/gateways.md) | - - - -### VnetInfoProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vnetResourceId | string | No | The Virtual Network's resource ID. | -| certBlob | array | No | A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection. - integer | -| dnsServers | string | No | DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. | - diff --git a/test/Resource/Expected/Web/2016-08-01/sites/virtualNetworkConnections/gateways.md b/test/Resource/Expected/Web/2016-08-01/sites/virtualNetworkConnections/gateways.md deleted file mode 100644 index c1af920..0000000 --- a/test/Resource/Expected/Web/2016-08-01/sites/virtualNetworkConnections/gateways.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Web/sites/virtualNetworkConnections/gateways template reference -API Version: 2016-08-01 -## Template format - -To create a Microsoft.Web/sites/virtualNetworkConnections/gateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/sites/virtualNetworkConnections/gateways", - "apiVersion": "2016-08-01", - "kind": "string", - "properties": { - "vnetName": "string", - "vpnPackageUri": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/sites/virtualNetworkConnections/gateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/sites/virtualNetworkConnections/gateways | -| apiVersion | enum | Yes | 2016-08-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | VnetGateway resource specific properties - [VnetGatewayProperties object](#VnetGatewayProperties) | - - - -### VnetGatewayProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vnetName | string | No | The Virtual Network name. | -| vpnPackageUri | string | Yes | The URI where the VPN package can be downloaded. | - diff --git a/test/Resource/Expected/Web/2016-09-01/Microsoft.Web.json b/test/Resource/Expected/Web/2016-09-01/Microsoft.Web.json deleted file mode 100644 index e132c3d..0000000 --- a/test/Resource/Expected/Web/2016-09-01/Microsoft.Web.json +++ /dev/null @@ -1,928 +0,0 @@ -{ - "id": "https://schema.management.azure.com/schemas/2016-09-01/Microsoft.Web.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Microsoft.Web", - "description": "Microsoft Web Resource Types", - "resourceDefinitions": { - "hostingEnvironments": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/hostingEnvironments" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AppServiceEnvironment" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Core resource properties" - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/hostingEnvironments_workerPools_childResource" - } - ] - } - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/hostingEnvironments" - }, - "hostingEnvironments_workerPools": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/hostingEnvironments/workerPools" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WorkerPool" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Core resource properties" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/SkuDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/hostingEnvironments/workerPools" - }, - "serverfarms": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/serverfarms" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "location": { - "type": "string", - "description": "Resource Location." - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "properties": {} - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Resource tags." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/AppServicePlanProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "AppServicePlan resource specific properties" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/SkuDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Web/serverfarms" - }, - "serverfarms_virtualNetworkConnections_gateways": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetGatewayProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetGateway resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways" - }, - "serverfarms_virtualNetworkConnections_routes": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Web/serverfarms/virtualNetworkConnections/routes" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VnetRouteProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "VnetRoute resource specific properties" - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/serverfarms/virtualNetworkConnections/routes" - } - }, - "definitions": { - "AppServiceEnvironment": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the App Service Environment." - }, - "location": { - "type": "string", - "description": "Location of the App Service Environment, e.g. \"West US\"." - }, - "vnetName": { - "type": "string", - "description": "Name of the Virtual Network for the App Service Environment." - }, - "vnetResourceGroupName": { - "type": "string", - "description": "Resource group of the Virtual Network." - }, - "vnetSubnetName": { - "type": "string", - "description": "Subnet of the Virtual Network." - }, - "virtualNetwork": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualNetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Description of the Virtual Network." - }, - "internalLoadBalancingMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Web", - "Publishing" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment." - }, - "multiSize": { - "type": "string", - "description": "Front-end VM size, e.g. \"Medium\", \"Large\"." - }, - "multiRoleCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of front-end instances." - }, - "workerPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/WorkerPool" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool." - }, - "ipsslAddressCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of IP SSL addresses reserved for the App Service Environment." - }, - "dnsSuffix": { - "type": "string", - "description": "DNS suffix of the App Service Environment." - }, - "networkAccessControlList": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkAccessControlEntry" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Access control list for controlling traffic to the App Service Environment." - }, - "frontEndScaleFactor": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Scale factor for front-ends." - }, - "apiManagementAccountId": { - "type": "string", - "description": "API Management Account associated with the App Service Environment." - }, - "suspended": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "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": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "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": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/NameValuePair" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Custom settings for changing the behavior of the App Service Environment." - }, - "userWhitelistedIpRanges": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "User added ip ranges to whitelist on ASE db" - } - }, - "required": [ - "name", - "location", - "virtualNetwork", - "workerPools" - ], - "description": "Description of an App Service Environment." - }, - "AppServicePlanProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name for the App Service plan." - }, - "workerTierName": { - "type": "string", - "description": "Target worker tier assigned to the App Service plan." - }, - "adminSiteName": { - "type": "string", - "description": "App Service plan administration site." - }, - "hostingEnvironmentProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HostingEnvironmentProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Specification for the App Service Environment to use for the App Service plan." - }, - "perSiteScaling": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "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." - }, - "isSpot": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If true, this App Service Plan owns spot instances." - }, - "spotExpirationTime": { - "type": "string", - "format": "date-time", - "description": "The time when the server farm expires. Valid only if it is a spot server farm." - }, - "reserved": { - "oneOf": [ - { - "type": "boolean", - "default": false - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "If Linux app service plan true, false otherwise." - }, - "targetWorkerCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Scaling worker count." - }, - "targetWorkerSizeId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Scaling worker size ID." - } - }, - "required": [ - "name" - ], - "description": "AppServicePlan resource specific properties" - }, - "Capability": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the SKU capability." - }, - "value": { - "type": "string", - "description": "Value of the SKU capability." - }, - "reason": { - "type": "string", - "description": "Reason of the SKU capability." - } - }, - "description": "Describes the capabilities/features allowed for a specific SKU." - }, - "HostingEnvironmentProfile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID of the App Service Environment." - } - }, - "description": "Specification for an App Service Environment to use for this resource." - }, - "hostingEnvironments_workerPools_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "workerPools" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-09-01" - ] - }, - "kind": { - "type": "string", - "description": "Kind of resource." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/WorkerPool" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Core resource properties" - }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/SkuDescription" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Web/hostingEnvironments/workerPools" - }, - "NameValuePair": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Pair name." - }, - "value": { - "type": "string", - "description": "Pair value." - } - }, - "description": "Name value pair." - }, - "NetworkAccessControlEntry": { - "type": "object", - "properties": { - "action": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Permit", - "Deny" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Action object." - }, - "description": { - "type": "string", - "description": "Description of network access control entry." - }, - "order": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Order of precedence." - }, - "remoteSubnet": { - "type": "string", - "description": "Remote subnet." - } - }, - "description": "Network access control entry." - }, - "SkuCapacity": { - "type": "object", - "properties": { - "minimum": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Minimum number of workers for this App Service plan SKU." - }, - "maximum": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Maximum number of workers for this App Service plan SKU." - }, - "default": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Default number of workers for this App Service plan SKU." - }, - "scaleType": { - "type": "string", - "description": "Available scale configurations for an App Service plan." - } - }, - "description": "Description of the App Service plan scale options." - }, - "SkuDescription": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the resource SKU." - }, - "tier": { - "type": "string", - "description": "Service tier of the resource SKU." - }, - "size": { - "type": "string", - "description": "Size specifier of the resource SKU." - }, - "family": { - "type": "string", - "description": "Family code of the resource SKU." - }, - "capacity": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Current number of instances assigned to the resource." - }, - "skuCapacity": { - "oneOf": [ - { - "$ref": "#/definitions/SkuCapacity" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Min, max, and default scale values of the SKU." - }, - "locations": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Locations of the SKU." - }, - "capabilities": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/Capability" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Capabilities of the SKU, e.g., is traffic manager enabled?" - } - }, - "description": "Description of a SKU for a scalable resource." - }, - "VirtualNetworkProfile": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource id of the Virtual Network." - }, - "subnet": { - "type": "string", - "description": "Subnet within the Virtual Network." - } - }, - "description": "Specification for using a Virtual Network." - }, - "VnetGatewayProperties": { - "type": "object", - "properties": { - "vnetName": { - "type": "string", - "description": "The Virtual Network name." - }, - "vpnPackageUri": { - "type": "string", - "description": "The URI where the VPN package can be downloaded." - } - }, - "required": [ - "vpnPackageUri" - ], - "description": "VnetGateway resource specific properties" - }, - "VnetRouteProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "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": "string", - "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": "string", - "description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted." - }, - "routeType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "DEFAULT", - "INHERITED", - "STATIC" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "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." - } - }, - "description": "VnetRoute resource specific properties" - }, - "WorkerPool": { - "type": "object", - "properties": { - "workerSizeId": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Worker size ID for referencing this worker pool." - }, - "computeMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Shared", - "Dedicated", - "Dynamic" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Shared or dedicated app hosting." - }, - "workerSize": { - "type": "string", - "description": "VM size of the worker pool instances." - }, - "workerCount": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#/definitions/expression" - } - ], - "description": "Number of instances in the worker pool." - } - }, - "description": "Worker pool of an App Service Environment." - } - } -} diff --git a/test/Resource/Expected/Web/2016-09-01/hostingEnvironments.md b/test/Resource/Expected/Web/2016-09-01/hostingEnvironments.md deleted file mode 100644 index 58d04c0..0000000 --- a/test/Resource/Expected/Web/2016-09-01/hostingEnvironments.md +++ /dev/null @@ -1,140 +0,0 @@ -# Microsoft.Web/hostingEnvironments template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Web/hostingEnvironments resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/hostingEnvironments", - "apiVersion": "2016-09-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "name": "string", - "location": "string", - "vnetName": "string", - "vnetResourceGroupName": "string", - "vnetSubnetName": "string", - "virtualNetwork": { - "id": "string", - "subnet": "string" - }, - "internalLoadBalancingMode": "string", - "multiSize": "string", - "multiRoleCount": "integer", - "workerPools": [ - { - "workerSizeId": "integer", - "computeMode": "string", - "workerSize": "string", - "workerCount": "integer" - } - ], - "ipsslAddressCount": "integer", - "dnsSuffix": "string", - "networkAccessControlList": [ - { - "action": "string", - "description": "string", - "order": "integer", - "remoteSubnet": "string" - } - ], - "frontEndScaleFactor": "integer", - "apiManagementAccountId": "string", - "suspended": "boolean", - "dynamicCacheEnabled": "boolean", - "clusterSettings": [ - { - "name": "string", - "value": "string" - } - ], - "userWhitelistedIpRanges": [ - "string" - ] - }, - "resources": [] -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/hostingEnvironments object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/hostingEnvironments | -| apiVersion | enum | Yes | 2016-09-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | Core resource properties - [AppServiceEnvironment object](#AppServiceEnvironment) | -| resources | array | No | [workerPools](./hostingEnvironments/workerPools.md) | - - - -### AppServiceEnvironment object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Name of the App Service Environment. | -| location | string | Yes | Location of the App Service Environment, e.g. "West US". | -| vnetName | string | No | Name of the Virtual Network for the App Service Environment. | -| vnetResourceGroupName | string | No | Resource group of the Virtual Network. | -| vnetSubnetName | string | No | Subnet of the Virtual Network. | -| virtualNetwork | object | Yes | Description of the Virtual Network. - [VirtualNetworkProfile object](#VirtualNetworkProfile) | -| internalLoadBalancingMode | enum | No | Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. - None, Web, Publishing | -| multiSize | string | No | Front-end VM size, e.g. "Medium", "Large". | -| multiRoleCount | integer | No | Number of front-end instances. | -| workerPools | array | Yes | Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. - [WorkerPool object](#WorkerPool) | -| ipsslAddressCount | integer | No | Number of IP SSL addresses reserved for the App Service Environment. | -| dnsSuffix | string | No | DNS suffix of the App Service Environment. | -| networkAccessControlList | array | No | Access control list for controlling traffic to the App Service Environment. - [NetworkAccessControlEntry object](#NetworkAccessControlEntry) | -| frontEndScaleFactor | integer | No | Scale factor for front-ends. | -| apiManagementAccountId | string | No | API Management Account associated with the App Service Environment. | -| suspended | boolean | No | true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic). | -| dynamicCacheEnabled | boolean | No | True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available(most likely because NSG blocked the incoming traffic). | -| clusterSettings | array | No | Custom settings for changing the behavior of the App Service Environment. - [NameValuePair object](#NameValuePair) | -| userWhitelistedIpRanges | array | No | User added ip ranges to whitelist on ASE db - string | - - - -### VirtualNetworkProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource id of the Virtual Network. | -| subnet | string | No | Subnet within the Virtual Network. | - - - -### WorkerPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| workerSizeId | integer | No | Worker size ID for referencing this worker pool. | -| computeMode | enum | No | Shared or dedicated app hosting. - Shared, Dedicated, Dynamic | -| workerSize | string | No | VM size of the worker pool instances. | -| workerCount | integer | No | Number of instances in the worker pool. | - - - -### NetworkAccessControlEntry object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| action | enum | No | Action object. - Permit or Deny | -| description | string | No | Description of network access control entry. | -| order | integer | No | Order of precedence. | -| remoteSubnet | string | No | Remote subnet. | - - - -### NameValuePair object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Pair name. | -| value | string | No | Pair value. | - diff --git a/test/Resource/Expected/Web/2016-09-01/hostingEnvironments/workerPools.md b/test/Resource/Expected/Web/2016-09-01/hostingEnvironments/workerPools.md deleted file mode 100644 index 571bca4..0000000 --- a/test/Resource/Expected/Web/2016-09-01/hostingEnvironments/workerPools.md +++ /dev/null @@ -1,101 +0,0 @@ -# Microsoft.Web/hostingEnvironments/workerPools template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Web/hostingEnvironments/workerPools resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/hostingEnvironments/workerPools", - "apiVersion": "2016-09-01", - "kind": "string", - "properties": { - "workerSizeId": "integer", - "computeMode": "string", - "workerSize": "string", - "workerCount": "integer" - }, - "sku": { - "name": "string", - "tier": "string", - "size": "string", - "family": "string", - "capacity": "integer", - "skuCapacity": { - "minimum": "integer", - "maximum": "integer", - "default": "integer", - "scaleType": "string" - }, - "locations": [ - "string" - ], - "capabilities": [ - { - "name": "string", - "value": "string", - "reason": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/hostingEnvironments/workerPools object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/hostingEnvironments/workerPools | -| apiVersion | enum | Yes | 2016-09-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | Core resource properties - [WorkerPool object](#WorkerPool) | -| sku | object | No | [SkuDescription object](#SkuDescription) | - - - -### WorkerPool object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| workerSizeId | integer | No | Worker size ID for referencing this worker pool. | -| computeMode | enum | No | Shared or dedicated app hosting. - Shared, Dedicated, Dynamic | -| workerSize | string | No | VM size of the worker pool instances. | -| workerCount | integer | No | Number of instances in the worker pool. | - - - -### SkuDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Name of the resource SKU. | -| tier | string | No | Service tier of the resource SKU. | -| size | string | No | Size specifier of the resource SKU. | -| family | string | No | Family code of the resource SKU. | -| capacity | integer | No | Current number of instances assigned to the resource. | -| skuCapacity | object | No | Min, max, and default scale values of the SKU. - [SkuCapacity object](#SkuCapacity) | -| locations | array | No | Locations of the SKU. - string | -| capabilities | array | No | Capabilities of the SKU, e.g., is traffic manager enabled? - [Capability object](#Capability) | - - - -### SkuCapacity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| minimum | integer | No | Minimum number of workers for this App Service plan SKU. | -| maximum | integer | No | Maximum number of workers for this App Service plan SKU. | -| default | integer | No | Default number of workers for this App Service plan SKU. | -| scaleType | string | No | Available scale configurations for an App Service plan. | - - - -### Capability object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Name of the SKU capability. | -| value | string | No | Value of the SKU capability. | -| reason | string | No | Reason of the SKU capability. | - diff --git a/test/Resource/Expected/Web/2016-09-01/serverfarms.md b/test/Resource/Expected/Web/2016-09-01/serverfarms.md deleted file mode 100644 index 42308f9..0000000 --- a/test/Resource/Expected/Web/2016-09-01/serverfarms.md +++ /dev/null @@ -1,126 +0,0 @@ -# Microsoft.Web/serverfarms template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Web/serverfarms resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/serverfarms", - "apiVersion": "2016-09-01", - "kind": "string", - "location": "string", - "tags": {}, - "properties": { - "name": "string", - "workerTierName": "string", - "adminSiteName": "string", - "hostingEnvironmentProfile": { - "id": "string" - }, - "perSiteScaling": "boolean", - "isSpot": "boolean", - "spotExpirationTime": "string", - "reserved": "boolean", - "targetWorkerCount": "integer", - "targetWorkerSizeId": "integer" - }, - "sku": { - "name": "string", - "tier": "string", - "size": "string", - "family": "string", - "capacity": "integer", - "skuCapacity": { - "minimum": "integer", - "maximum": "integer", - "default": "integer", - "scaleType": "string" - }, - "locations": [ - "string" - ], - "capabilities": [ - { - "name": "string", - "value": "string", - "reason": "string" - } - ] - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/serverfarms object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/serverfarms | -| apiVersion | enum | Yes | 2016-09-01 | -| kind | string | No | Kind of resource. | -| location | string | Yes | Resource Location. | -| tags | object | No | Resource tags. | -| properties | object | Yes | AppServicePlan resource specific properties - [AppServicePlanProperties object](#AppServicePlanProperties) | -| sku | object | No | [SkuDescription object](#SkuDescription) | - - - -### AppServicePlanProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | Name for the App Service plan. | -| workerTierName | string | No | Target worker tier assigned to the App Service plan. | -| adminSiteName | string | No | App Service plan administration site. | -| hostingEnvironmentProfile | object | No | Specification for the App Service Environment to use for the App Service plan. - [HostingEnvironmentProfile object](#HostingEnvironmentProfile) | -| perSiteScaling | boolean | No | 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. | -| isSpot | boolean | No | If true, this App Service Plan owns spot instances. | -| spotExpirationTime | string | No | The time when the server farm expires. Valid only if it is a spot server farm. | -| reserved | boolean | No | If Linux app service plan true, false otherwise. | -| targetWorkerCount | integer | No | Scaling worker count. | -| targetWorkerSizeId | integer | No | Scaling worker size ID. | - - - -### SkuDescription object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Name of the resource SKU. | -| tier | string | No | Service tier of the resource SKU. | -| size | string | No | Size specifier of the resource SKU. | -| family | string | No | Family code of the resource SKU. | -| capacity | integer | No | Current number of instances assigned to the resource. | -| skuCapacity | object | No | Min, max, and default scale values of the SKU. - [SkuCapacity object](#SkuCapacity) | -| locations | array | No | Locations of the SKU. - string | -| capabilities | array | No | Capabilities of the SKU, e.g., is traffic manager enabled? - [Capability object](#Capability) | - - - -### HostingEnvironmentProfile object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| id | string | No | Resource ID of the App Service Environment. | - - - -### SkuCapacity object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| minimum | integer | No | Minimum number of workers for this App Service plan SKU. | -| maximum | integer | No | Maximum number of workers for this App Service plan SKU. | -| default | integer | No | Default number of workers for this App Service plan SKU. | -| scaleType | string | No | Available scale configurations for an App Service plan. | - - - -### Capability object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | Name of the SKU capability. | -| value | string | No | Value of the SKU capability. | -| reason | string | No | Reason of the SKU capability. | - diff --git a/test/Resource/Expected/Web/2016-09-01/serverfarms/virtualNetworkConnections/gateways.md b/test/Resource/Expected/Web/2016-09-01/serverfarms/virtualNetworkConnections/gateways.md deleted file mode 100644 index 0f8cfdf..0000000 --- a/test/Resource/Expected/Web/2016-09-01/serverfarms/virtualNetworkConnections/gateways.md +++ /dev/null @@ -1,40 +0,0 @@ -# Microsoft.Web/serverfarms/virtualNetworkConnections/gateways template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Web/serverfarms/virtualNetworkConnections/gateways resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways", - "apiVersion": "2016-09-01", - "kind": "string", - "properties": { - "vnetName": "string", - "vpnPackageUri": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/serverfarms/virtualNetworkConnections/gateways object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/serverfarms/virtualNetworkConnections/gateways | -| apiVersion | enum | Yes | 2016-09-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | VnetGateway resource specific properties - [VnetGatewayProperties object](#VnetGatewayProperties) | - - - -### VnetGatewayProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| vnetName | string | No | The Virtual Network name. | -| vpnPackageUri | string | Yes | The URI where the VPN package can be downloaded. | - diff --git a/test/Resource/Expected/Web/2016-09-01/serverfarms/virtualNetworkConnections/routes.md b/test/Resource/Expected/Web/2016-09-01/serverfarms/virtualNetworkConnections/routes.md deleted file mode 100644 index 62ec049..0000000 --- a/test/Resource/Expected/Web/2016-09-01/serverfarms/virtualNetworkConnections/routes.md +++ /dev/null @@ -1,44 +0,0 @@ -# Microsoft.Web/serverfarms/virtualNetworkConnections/routes template reference -API Version: 2016-09-01 -## Template format - -To create a Microsoft.Web/serverfarms/virtualNetworkConnections/routes resource, add the following JSON to the resources section of your template. - -```json -{ - "name": "string", - "type": "Microsoft.Web/serverfarms/virtualNetworkConnections/routes", - "apiVersion": "2016-09-01", - "kind": "string", - "properties": { - "name": "string", - "startAddress": "string", - "endAddress": "string", - "routeType": "string" - } -} -``` -## Property values - -The following tables describe the values you need to set in the schema. - - -### Microsoft.Web/serverfarms/virtualNetworkConnections/routes object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | Yes | | -| type | enum | Yes | Microsoft.Web/serverfarms/virtualNetworkConnections/routes | -| apiVersion | enum | Yes | 2016-09-01 | -| kind | string | No | Kind of resource. | -| properties | object | Yes | VnetRoute resource specific properties - [VnetRouteProperties object](#VnetRouteProperties) | - - - -### VnetRouteProperties object -| Name | Type | Required | Value | -| ---- | ---- | ---- | ---- | -| name | string | No | The name of this route. This is only returned by the server and does not need to be set by the client. | -| startAddress | string | No | The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. | -| endAddress | string | No | The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. | -| routeType | enum | No | The type of route this is:DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918INHERITED - Routes inherited from the real Virtual Network routesSTATIC - Static route set on the app onlyThese values will be used for syncing an app's routes with those from a Virtual Network. - DEFAULT, INHERITED, STATIC | -