Fix parameter for api version naming consistency

This commit is contained in:
JDinisHiscox 2023-10-25 15:18:41 +01:00
Родитель ed746b7a4e
Коммит 855722ee74
4 изменённых файлов: 4 добавлений и 4 удалений

Просмотреть файл

@ -21,7 +21,7 @@ The tool expects certain configuration parameters. These can be passed as enviro
| API_MANAGEMENT_SERVICE_NAME | Name of the APIM instance to be extracted |
| API_MANAGEMENT_SERVICE_OUTPUT_FOLDER_PATH | Folder where the APIM artifacts will be saved |
| API_SPECIFICATION_FORMAT | OpenAPI specification format. Valid options are **JSON** or **YAML**. If the variable is missing or invalid, **YAML** will be used by default |
| ARM-API-VERSION | Azure ARM API version that will be used. This is a optional parameter and will default to **2022-04-01-preview** if not specified, other versions can be found here [APIM Rest API Reference - Overview Docs](https://learn.microsoft.com/en-us/rest/api/apimanagement/current-ga/api-diagnostic/create-or-update?tabs=HTTP).
| ARM_API_VERSION | Azure ARM API version that will be used. This is a optional parameter and will default to **2022-04-01-preview** if not specified, other versions can be found here [APIM Rest API Reference - Overview Docs](https://learn.microsoft.com/en-us/rest/api/apimanagement/current-ga/api-diagnostic/create-or-update?tabs=HTTP).
| CONFIGURATION_YAML_PATH | Path to the Yaml configuration file used to specify select apis to extract. A sample yaml extractor configuration file to signal to the extractor to extract select apis. This is an optional parameter and will only come into play if you want different teams to manage different apis. You typically will have one configuration per team. Note: You can call the file whatever you want as long as you reference the right file within your extractor pipeline.
| AZURE_CLOUD_ENVIRONMENT | Azure Authority Host Service url that will be used. This is a optional parameter and will default to **AzurePublicCloud** if not specified.
| Logging__LogLevel__Default: | The allowed values are either "Information", "Debug", or "Trace". Table below shows the description of each logging level.

Просмотреть файл

@ -19,7 +19,7 @@ The tool expects certain configuration parameters. These can be passed as enviro
| API_MANAGEMENT_SERVICE_OUTPUT_FOLDER_PATH | Folder where the APIM artifacts are located |
| AZURE_BEARER_TOKEN | Token for authentication to Azure. If this is not specified, the tool authenticate with the [``DefaultAzureCredential``](https://docs.microsoft.com/en-us/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet) |
| API_MANAGEMENT_SERVICE_NAME | Name of the APIM instance to publish to. This can also be parsed from the configuration file |
| ARM-API-VERSION | Azure ARM API version that will be used. This is a optional parameter and will default to **2022-04-01-preview** if not specified, other versions can be found here [APIM Rest API Reference - Overview Docs](https://learn.microsoft.com/en-us/rest/api/apimanagement/current-ga/api-diagnostic/create-or-update?tabs=HTTP).
| ARM_API_VERSION | Azure ARM API version that will be used. This is a optional parameter and will default to **2022-04-01-preview** if not specified, other versions can be found here [APIM Rest API Reference - Overview Docs](https://learn.microsoft.com/en-us/rest/api/apimanagement/current-ga/api-diagnostic/create-or-update?tabs=HTTP).
| CONFIGURATION_YAML_PATH | Path to the Yaml configuration file used to override different configurations (e.g. policy backend value, namevalue pairs, just to name a few) when promoting across APIM environments (e.g. dev -> qa -> prod). You will need a unique Yaml configuration file per environment (e.g. configuration.prod.yaml for production) when overriding configurations across environments. The configuration file is not mandatory. If you don't provide it, the overrides will be picked from the environment variables as discussed in the wiki [here](https://github.com/Azure/apiops/wiki/Configuration#configuration-providers). Remember that you always need to provide the apimServiceName at a minimum which informs the publisher about the destination apim instance |
| AZURE_CLOUD_ENVIRONMENT | Azure Authority Host Service url that will be used. This is a optional parameter and will default to **AzurePublicCloud** if not specified.
| COMMIT_ID | Git commit ID. If specified, the tool will only use files that were affected by that commit. New/modified files will be updated in Azure, and deleted artifacts will be removed from the Azure APIM instance. If unspecified, the tool will do a Put operation on the Azure APIM instance with all files in the artifacts folder |

Просмотреть файл

@ -292,7 +292,7 @@ public static class Program
.AppendPathSegment(configuration.GetValue("AZURE_RESOURCE_GROUP_NAME"))
.AppendPathSegment("providers/Microsoft.ApiManagement/service")
.AppendPathSegment(serviceName)
.SetQueryParam("api-version", configuration.GetValue("ARM-API-VERSION", "2022-04-01-preview"))
.SetQueryParam("api-version", configuration.GetValue("ARM_API_VERSION", "2022-04-01-preview"))
.ToUri();
return new ServiceUri(uri);

Просмотреть файл

@ -285,7 +285,7 @@ public static class Program
.AppendPathSegment(configuration.GetValue("AZURE_RESOURCE_GROUP_NAME"))
.AppendPathSegment("providers/Microsoft.ApiManagement/service")
.AppendPathSegment(serviceName)
.SetQueryParam("api-version", configuration.GetValue("ARM-API-VERSION", "2022-04-01-preview"))
.SetQueryParam("api-version", configuration.GetValue("ARM_API_VERSION", "2022-04-01-preview"))
.ToUri();
return new ServiceUri(uri);