@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.02 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets Kubernetes Cluster Extension.
*
* Uses Azure REST API version 2023-05-01.
*
* Other available API versions: 2022-04-02-preview, 2022-07-01, 2022-11-01, 2024-11-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native kubernetesconfiguration [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getExtension(args: GetExtensionArgs, opts?: pulumi.InvokeOptions): Promise<GetExtensionResult>;
export interface GetExtensionArgs {
/**
* The name of the kubernetes cluster.
*/
clusterName: string;
/**
* The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.
*/
clusterResourceName: string;
/**
* The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.
*/
clusterRp: string;
/**
* Name of the Extension.
*/
extensionName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* The Extension object.
*/
export interface GetExtensionResult {
/**
* Identity of the Extension resource in an AKS cluster
*/
readonly aksAssignedIdentity?: outputs.kubernetesconfiguration.ExtensionResponseAksAssignedIdentity;
/**
* Flag to note if this extension participates in auto upgrade of minor version, or not.
*/
readonly autoUpgradeMinorVersion?: boolean;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Configuration settings that are sensitive, as name-value pairs for configuring this extension.
*/
readonly configurationProtectedSettings?: {
[key: string]: string;
};
/**
* Configuration settings, as name-value pairs for configuring this extension.
*/
readonly configurationSettings?: {
[key: string]: string;
};
/**
* Currently installed version of the extension.
*/
readonly currentVersion: string;
/**
* Custom Location settings properties.
*/
readonly customLocationSettings: {
[key: string]: string;
};
/**
* Error information from the Agent - e.g. errors during installation.
*/
readonly errorInfo: outputs.kubernetesconfiguration.ErrorDetailResponse;
/**
* Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher.
*/
readonly extensionType?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* Identity of the Extension resource
*/
readonly identity?: outputs.kubernetesconfiguration.IdentityResponse;
/**
* Flag to note if this extension is a system extension
*/
readonly isSystemExtension: boolean;
/**
* The name of the resource
*/
readonly name: string;
/**
* Uri of the Helm package
*/
readonly packageUri: string;
/**
* The plan information.
*/
readonly plan?: outputs.kubernetesconfiguration.PlanResponse;
/**
* Status of installation of this extension.
*/
readonly provisioningState: string;
/**
* ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.
*/
readonly releaseTrain?: string;
/**
* Scope at which the extension is installed.
*/
readonly scope?: outputs.kubernetesconfiguration.ScopeResponse;
/**
* Status from this extension.
*/
readonly statuses?: outputs.kubernetesconfiguration.ExtensionStatusResponse[];
/**
* Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
*/
readonly systemData: outputs.kubernetesconfiguration.SystemDataResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* User-specified version of the extension for this extension to 'pin'. To use 'version', autoUpgradeMinorVersion must be 'false'.
*/
readonly version?: string;
}
/**
* Gets Kubernetes Cluster Extension.
*
* Uses Azure REST API version 2023-05-01.
*
* Other available API versions: 2022-04-02-preview, 2022-07-01, 2022-11-01, 2024-11-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native kubernetesconfiguration [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getExtensionOutput(args: GetExtensionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetExtensionResult>;
export interface GetExtensionOutputArgs {
/**
* The name of the kubernetes cluster.
*/
clusterName: pulumi.Input<string>;
/**
* The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.
*/
clusterResourceName: pulumi.Input<string>;
/**
* The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.
*/
clusterRp: pulumi.Input<string>;
/**
* Name of the Extension.
*/
extensionName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}