|
| 1 | +# azurestackhci |
| 2 | + |
| 3 | +> see https://aka.ms/autorest |
| 4 | +
|
| 5 | +This is the AutoRest configuration file for azurestackhci. |
| 6 | + |
| 7 | +## Getting Started |
| 8 | + |
| 9 | +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: |
| 10 | + |
| 11 | +> `autorest readme.md` |
| 12 | +
|
| 13 | +To see additional help and options, run: |
| 14 | + |
| 15 | +> `autorest --help` |
| 16 | +
|
| 17 | +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## Configuration |
| 22 | + |
| 23 | +### Basic Information |
| 24 | + |
| 25 | +These are the global settings for the azurestackhci. |
| 26 | + |
| 27 | +``` yaml |
| 28 | +title: AzureStackHCIClient |
| 29 | +description: Azure Stack HCI management service |
| 30 | +openapi-type: arm |
| 31 | +openapi-subtype: rpaas |
| 32 | +tag: package-2024-04 |
| 33 | +``` |
| 34 | +
|
| 35 | +## Suppression |
| 36 | +
|
| 37 | +``` yaml |
| 38 | +directive: |
| 39 | + - suppress: R3020 |
| 40 | + from: |
| 41 | + - arcSettings.json |
| 42 | + - clusters.json |
| 43 | + - extensions.json |
| 44 | + - operations.json |
| 45 | + - offers.json |
| 46 | + - publishers.json |
| 47 | + - skus.json |
| 48 | + - updates.json |
| 49 | + - updateRuns.json |
| 50 | + - updateSummaries.json |
| 51 | + - deploymentSettings.json |
| 52 | + - edgeDevices.json |
| 53 | + - securitySettings.json |
| 54 | + - hciCommon.json |
| 55 | + |
| 56 | + reason: Microsoft.AzureStackHCI is the correct name for our RP. |
| 57 | +suppressions: |
| 58 | + - code: PathResourceProviderNamePascalCase |
| 59 | + reason: Microsoft.AzureStackHCI was chosen over Microsoft.AzureStackHci or Microsoft.AzureStackHyperConvergedInfrastructure |
| 60 | + from: |
| 61 | + - arcSettings.json |
| 62 | + - clusters.json |
| 63 | + - extensions.json |
| 64 | + - operations.json |
| 65 | + - offers.json |
| 66 | + - publishers.json |
| 67 | + - skus.json |
| 68 | + - updates.json |
| 69 | + - updateRuns.json |
| 70 | + - updateSummaries.json |
| 71 | + - deploymentSettings.json |
| 72 | + - edgeDevices.json |
| 73 | + - securitySettings.json |
| 74 | + |
| 75 | + - code: ResourceNameRestriction |
| 76 | + reason: ClusterName didn't have a pattern initially, adding the constraint now will cause a breaking change |
| 77 | + from: |
| 78 | + - deploymentSettings.json |
| 79 | + - clusters.json |
| 80 | + - securitySettings.json |
| 81 | + - arcSettings.json |
| 82 | + - extensions.json |
| 83 | + - offers.json |
| 84 | + - publishers.json |
| 85 | + - skus.json |
| 86 | + - updateRuns.json |
| 87 | + - updates.json |
| 88 | + - updateSummaries.json |
| 89 | + |
| 90 | + - code: ParametersInPointGet |
| 91 | + reason: already used in GA api version, fixing it will cause a breaking change |
| 92 | + from: |
| 93 | + - offers.json |
| 94 | + - skus.json |
| 95 | + |
| 96 | + - code: PatchPropertiesCorrespondToPutProperties |
| 97 | + reason: already used in GA api version, fixing it will cause breaking change |
| 98 | + from: |
| 99 | + - clusters.json |
| 100 | + |
| 101 | + - code: PatchBodyParametersSchema |
| 102 | + reason: already used in GA api version, fixing it will cause breaking change |
| 103 | + from: |
| 104 | + - clusters.json |
| 105 | + |
| 106 | + - code: PutResponseCodes |
| 107 | + reason: already used in GA api version, fixing it will cause breaking change |
| 108 | + from: |
| 109 | + - clusters.json |
| 110 | + - arcSettings.json |
| 111 | + - updateRuns.json |
| 112 | + - updates.json |
| 113 | + - updateSummaries.json |
| 114 | + |
| 115 | + - code: ConsistentPatchProperties |
| 116 | + reason: already used in GA api version, fixing it will cause breaking change |
| 117 | + from: |
| 118 | + - arcSettings.json |
| 119 | + |
| 120 | + - code: PostResponseCodes |
| 121 | + reason: already used in GA api version, fixing it will cause breaking change |
| 122 | + from: |
| 123 | + - arcSettings.json |
| 124 | + - updates.json |
| 125 | + |
| 126 | + - code: DeleteResponseCodes |
| 127 | + reason: already used in GA api version, fixing it will cause breaking change |
| 128 | + from: |
| 129 | + - clusters.json |
| 130 | + - extensions.json |
| 131 | + - arcSettings.json |
| 132 | + - updateRuns.json |
| 133 | + - updates.json |
| 134 | + - updateSummaries.json |
| 135 | + |
| 136 | + - code: LroLocationHeader |
| 137 | + reason: already used in GA api version, fixing it will cause breaking change |
| 138 | + from: |
| 139 | + - extensions.json |
| 140 | + - clusters.json |
| 141 | + - arcSettings.json |
| 142 | + - updateRuns.json |
| 143 | + - updates.json |
| 144 | + - updateSummaries.json |
| 145 | + |
| 146 | + - code: ProvisioningStateSpecifiedForLROPut |
| 147 | + reason: already working without the properties section, adding it will break polymorphism |
| 148 | + from: |
| 149 | + - edgeDevices.json |
| 150 | + |
| 151 | + - code: XmsPageableForListCalls |
| 152 | + reason: already used in GA api version, fixing it will cause breaking change |
| 153 | + from: |
| 154 | + - operations.json |
| 155 | + - updateSummaries.json |
| 156 | + |
| 157 | + - code: RequestSchemaForTrackedResourcesMustHaveTags |
| 158 | + reason: these are not tracked resources, so tags are not needed |
| 159 | + from: |
| 160 | + - updates.json |
| 161 | + - updateRuns.json |
| 162 | + - updateSummaries.json |
| 163 | + |
| 164 | + - code: TrackedResourcePatchOperation |
| 165 | + reason: these are not tracked resources, so no tags and corresponding patch operation is needed |
| 166 | + from: |
| 167 | + - updates.json |
| 168 | + - updateRuns.json |
| 169 | + - updateSummaries.json |
| 170 | + |
| 171 | + - code: AvoidAdditionalProperties |
| 172 | + reason: already used in GA api version, fixing it will cause breaking change |
| 173 | + from: |
| 174 | + - updates.json |
| 175 | + |
| 176 | + - code: EvenSegmentedPathForPutOperation |
| 177 | + reason: already used in GA api version, fixing it will cause breaking change |
| 178 | + from: |
| 179 | + - updateSummaries.json |
| 180 | + |
| 181 | + - code: DefinitionsPropertiesNamesCamelCase |
| 182 | + reason: We have a dependency on other team which is already using these values, changing it will break backward compatibility |
| 183 | + from: |
| 184 | + - deploymentSettings.json |
| 185 | + where: |
| 186 | + - $.definitions.QosPolicyOverrides.properties.priorityValue8021Action_Cluster |
| 187 | + - $.definitions.QosPolicyOverrides.properties.priorityValue8021Action_SMB |
| 188 | + - $.definitions.QosPolicyOverrides.properties.bandwidthPercentage_SMB |
| 189 | + - $.definitions.SetInformationJobProperties.properties.priorityValue8021Action_Cluster |
| 190 | + - $.definitions.SetInformationJobProperties.properties.priorityValue8021Action_SMB |
| 191 | + - $.definitions.SetInformationJobProperties.properties.bandwidthPercentage_SMB |
| 192 | + |
| 193 | + - code: TopLevelResourcesListBySubscription |
| 194 | + reason: It is reporting issue for proxy extension resource which doesn't have use case to ListBySubscription as this resource will always tied to one parent resource only. Additionally, there is a 1:1 relationship between HybridCompute Machines and AzureStackHCI VirtualMachineInstances. |
| 195 | +``` |
| 196 | +
|
| 197 | +
|
| 198 | +### Tag: package-2024-04 |
| 199 | +
|
| 200 | +These settings apply only when `--tag=package-2024-04` is specified on the command line. |
| 201 | + |
| 202 | +```yaml $(tag) == 'package-2024-04' |
| 203 | +input-file: |
| 204 | + - stable/2024-04-01/arcSettings.json |
| 205 | + - stable/2024-04-01/clusters.json |
| 206 | + - stable/2024-04-01/deploymentSettings.json |
| 207 | + - stable/2024-04-01/edgeDevices.json |
| 208 | + - stable/2024-04-01/extensions.json |
| 209 | + - stable/2024-04-01/hciCommon.json |
| 210 | + - stable/2024-04-01/offers.json |
| 211 | + - ../operations/stable/2024-04-01/operations.json |
| 212 | + - stable/2024-04-01/publishers.json |
| 213 | + - stable/2024-04-01/securitySettings.json |
| 214 | + - stable/2024-04-01/skus.json |
| 215 | + - stable/2024-04-01/updateRuns.json |
| 216 | + - stable/2024-04-01/updateSummaries.json |
| 217 | + - stable/2024-04-01/updates.json |
| 218 | +``` |
| 219 | + |
| 220 | +--- |
| 221 | + |
| 222 | +# Code Generation |
| 223 | + |
| 224 | +## Swagger to SDK |
| 225 | + |
| 226 | +This section describes what SDK should be generated by the automatic system. |
| 227 | +This is not used by Autorest itself. |
| 228 | + |
| 229 | +``` yaml $(swagger-to-sdk) |
| 230 | +swagger-to-sdk: |
| 231 | + - repo: azure-sdk-for-python-track2 |
| 232 | + - repo: azure-sdk-for-java |
| 233 | + - repo: azure-sdk-for-go |
| 234 | + - repo: azure-sdk-for-js |
| 235 | + after_scripts: |
| 236 | + - bundle install && rake arm:regen_all_profiles['azure_mgmt_azurestackhci'] |
| 237 | + - repo: azure-resource-manager-schemas |
| 238 | + after_scripts: |
| 239 | + - node sdkauto_afterscript.js azurestackhci/resource-manager |
| 240 | + - repo: azure-powershell |
| 241 | +``` |
| 242 | + |
0 commit comments