Az.KubernetesConfiguration

This directory contains the PowerShell module for the KubernetesConfiguration service.

---

Info

• Modifiable: yes
• Generated: all
• Committed: yes
• Packaged: yes

---

Detail

This module was primarily generated via AutoRest using the PowerShell extension.

Module Requirements

• Az.Accounts module, version 2.7.5 or greater

Authentication

AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.

Development

For information on how to develop for Az.KubernetesConfiguration, see how-to.md.

---

Generation Requirements

Use of the beta version of autorest.powershell generator requires the following:

• NodeJS LTS (10.15.x LTS preferred)
  • Note: It will not work with Node < 10.x. Using 11.x builds may cause issues as they may introduce instability or breaking changes.

If you want an easy way to install and update Node, NVS - Node Version Switcher or NVM - Node Version Manager is recommended.

• AutoRest v3 beta
  npm install -g autorest@beta
   
• PowerShell 6.0 or greater
  • If you don't have it installed, you can use the cross-platform npm package
    npm install -g pwsh
     
• .NET Core SDK 2.0 or greater
  • If you don't have it installed, you can use the cross-platform npm package
    npm install -g dotnet-sdk-2.2
     

Run Generation

In this directory, run AutoRest:

autorest

---

AutoRest Configuration

see https://aka.ms/autorest

commit: d11245bcaa06b6d87db179c903ba4b049adf1bf2
require:
  - $(this-folder)/../../readme.azure.noprofile.md
input-file:
  - $(repo)/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2022-11-01/extensions.json
  - $(repo)/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2022-11-01/fluxconfiguration.json
  - $(repo)/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2022-11-01/operations.json
  - $(repo)/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2022-11-01/kubernetesconfiguration.json

title: KubernetesConfiguration
module-version: 0.3.0
subject-prefix: ''

identity-correction-for-post: true
resourcegroup-append: true
nested-object-to-string: true

# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
use-extension:
  "@autorest/powershell": "3.x"

directive:
  - from: swagger-document 
    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}"].patch.responses
    transform: >-
      return {
        "200": {
          "description": "No update is done to extension so return OK",
          "schema": {
            "$ref": "#/definitions/Extension"
          }
        },
        "201": {
          "description": "Request received successfully.",
          "schema": {
            "$ref": "#/definitions/Extension"
          }
        },
        "202": {
          "description": "Request received successfully, and the resource will be updated asynchronously.",
          "schema": {
            "$ref": "#/definitions/Extension"
          }
        },
        "409": {
          "description": "Conflict",
          "x-ms-error-response": true,
          "schema": {
            "$ref": "https://github.com/Azure/azure-rest-api-specs/blob/d11245bcaa06b6d87db179c903ba4b049adf1bf2/specification/common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
          }
        },
        "default": {
          "description": "Error response describing why the operation failed.",
          "schema": {
            "$ref": "https://github.com/Azure/azure-rest-api-specs/blob/d11245bcaa06b6d87db179c903ba4b049adf1bf2/specification/common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
          }
        }
      }
  - from: swagger-document 
    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/fluxConfigurations/{fluxConfigurationName}"].put.responses
    transform: >-
      return {
        "200": {
          "description": "Request received successfully for an existing resource.",
          "schema": {
            "$ref": "#/definitions/FluxConfiguration"
          }
        },
        "201": {
          "description": "Request received successfully.",
          "schema": {
            "$ref": "#/definitions/FluxConfiguration"
          }
        },
        "400": {
          "description": "Conflict",
          "x-ms-error-response": true,
          "schema": {
            "$ref": "https://github.com/Azure/azure-rest-api-specs/blob/d11245bcaa06b6d87db179c903ba4b049adf1bf2/specification/common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
          }
        },
        "default": {
          "description": "Error response describing why the operation failed.",
          "schema": {
            "$ref": "https://github.com/Azure/azure-rest-api-specs/blob/d11245bcaa06b6d87db179c903ba4b049adf1bf2/specification/common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
          }
        }
      }
  - from: swagger-document 
    where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/fluxConfigurations/{fluxConfigurationName}"].patch.responses
    transform: >-
      return {
        "200": {
          "description": "Request received successfully for an existing resource.",
          "schema": {
            "$ref": "#/definitions/FluxConfiguration"
          }
        },
        "202": {
          "description": "Request received successfully, and the resource will be updated asynchronously.",
          "schema": {
            "$ref": "#/definitions/FluxConfiguration"
          }
        },
        "default": {
          "description": "Error response describing why the operation failed.",
          "schema": {
            "$ref": "https://github.com/Azure/azure-rest-api-specs/blob/d11245bcaa06b6d87db179c903ba4b049adf1bf2/specification/common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
          }
        }
      }
  - from: swagger-document 
    where: $.definitions.Extension.properties.properties.properties.statuses
    transform: >-
      return {
        "description": "Status from this extension.",
        "type": "array",
        "readOnly": true,
        "x-nullable": true,
        "items": {
          "$ref": "#/definitions/ExtensionStatus"
        },
        "x-ms-identifiers": []
      }
  - from: swagger-document 
    where: $.definitions.BucketDefinition.properties.accessKey
    transform: >-
      return {
        "description": "Plaintext access key used to securely access the S3 bucket",
        "type": "string",
        "format": "password",
        "x-ms-secret": true,
        "x-nullable": true
      }
  - from: swagger-document 
    where: $.definitions.BucketPatchDefinition.properties.accessKey
    transform: >-
      return {
        "description": "Plaintext access key used to securely access the S3 bucket",
        "type": "string",
        "format": "password",
        "x-ms-secret": true,
        "x-nullable": true
      }
  - from: swagger-document
    where: $.definitions.EnableHelmOperatorDefinition.type
    transform: return "string"

  - where:
      variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$
    remove: true

  - where:
      subject: SourceControlConfiguration
    set:
      subject: KubernetesConfiguration
  - where:
      subject: FluxConfiguration
    set:
      subject: KubernetesConfigurationFlux
  - where:
      subject: FluxConfigOperationStatus
    set:
      subject: KubernetesConfigFluxOperationStatus
  - where:
      subject: ^Extension$
    set:
      subject: KubernetesExtension

  - where:
      parameter-name: NamespaceTargetNamespace
    set:
      parameter-name: TargetNamespace
  - where:
      parameter-name: ClusterReleaseNamespace
    set:
      parameter-name: ReleaseNamespace
  - where:
      parameter-name: ClusterResourceName
    set:
      parameter-name: ClusterType
  - where:
      verb: New
      subject: KubernetesConfiguration
      parameter-name: HelmOperatorPropertyChartValue
    set:
      parameter-name: HelmOperatorChartValue
  - where:
      verb: New
      subject: KubernetesConfiguration
      parameter-name: HelmOperatorPropertyChartVersion
    set:
      parameter-name: HelmOperatorChartVersion
  - where:
      verb: New
      subject: KubernetesConfiguration
      parameter-name: OperatorParameters
    set:
      parameter-name: OperatorParameter
  - where:
      verb: New
      subject: KubernetesConfiguration
      parameter-name: SshKnownHostsContent
    set:
      parameter-name: SshKnownHost

  - where:
      verb: Set
    remove: true
  - where:
      subject: OperationStatus
    remove: true

  - where:
      subject: KubernetesConfiguration
    hide: true
  - where:
      subject: KubernetesExtension
    hide: true
  - where:
      subject: KubernetesConfigurationFlux
    hide: true
  - where:
      subject: KubernetesConfigFluxOperationStatus
    hide: true

  - where:
      verb: Get
      subject: KubernetesExtension
    set:
      alias: Get-AzK8sExtension
  - where:
      verb: New
      subject: KubernetesExtension
    set:
      alias: New-AzK8sExtension
  - where:
      verb: Remove
      subject: KubernetesExtension
    set:
      alias: Remove-AzK8sExtension
  - where:
      verb: Update
      subject: KubernetesExtension
    set:
      alias: Update-AzK8sExtension
  - where:
      verb: Get
      subject: KubernetesConfiguration
    set:
      alias: Get-AzK8sConfiguration
  - where:
      verb: New
      subject: KubernetesConfiguration
    set:
      alias: New-AzK8sConfiguration
  - where:
      verb: Remove
      subject: KubernetesConfiguration
    set:
      alias: Remove-AzK8sConfiguration
  - where:
      verb: New
      subject: KubernetesConfigurationFlux
    set:
      alias: New-AzK8sConfigurationFlux
  - where:
      verb: Get
      subject: KubernetesConfigurationFlux
    set:
      alias: Get-AzK8sConfigurationFlux
  - where:
      verb: Remove
      subject: KubernetesConfigurationFlux
    set:
      alias: Remove-AzK8sConfigurationFlux
  - where:
      verb: Update
      subject: KubernetesConfigurationFlux
    set:
      alias: Update-AzK8sConfigurationFlux
  - where:
      verb: Get
      subject: KubernetesConfigFluxOperationStatus
    set:
      alias: Get-AzK8sConfigFluxOperationStatus

  - where:
      model-name: Extension
    set:
      format-table:
        properties:
          - Name
          - ExtensionType
          - Version
          - ProvisioningState
          - AutoUpgradeMinorVersion
          - ReleaseTrain
  - where:
      model-name: SourceControlConfiguration
    set:
      format-table:
        properties:
          - Name
          - RepositoryUrl
          - ResourceGroupName

  - where:
      parameter-name: ClusterType
    set:
      completer:
        script: "'ManagedClusters', 'ConnectedClusters', 'ProvisionedClusters'"