@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.18 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets an availability group listener.
*
* Uses Azure REST API version 2023-10-01.
*
* Other available API versions: 2022-02-01, 2022-07-01-preview, 2022-08-01-preview, 2023-01-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native sqlvirtualmachine [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getAvailabilityGroupListener(args: GetAvailabilityGroupListenerArgs, opts?: pulumi.InvokeOptions): Promise<GetAvailabilityGroupListenerResult>;
export interface GetAvailabilityGroupListenerArgs {
/**
* Name of the availability group listener.
*/
availabilityGroupListenerName: string;
/**
* The child resources to include in the response.
*/
expand?: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* Name of the SQL virtual machine group.
*/
sqlVirtualMachineGroupName: string;
}
/**
* A SQL Server availability group listener.
*/
export interface GetAvailabilityGroupListenerResult {
/**
* Availability Group configuration.
*/
readonly availabilityGroupConfiguration?: outputs.sqlvirtualmachine.AgConfigurationResponse;
/**
* Name of the availability group.
*/
readonly availabilityGroupName?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Create a default availability group if it does not exist.
*/
readonly createDefaultAvailabilityGroupIfNotExist?: boolean;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* List of load balancer configurations for an availability group listener.
*/
readonly loadBalancerConfigurations?: outputs.sqlvirtualmachine.LoadBalancerConfigurationResponse[];
/**
* List of multi subnet IP configurations for an AG listener.
*/
readonly multiSubnetIpConfigurations?: outputs.sqlvirtualmachine.MultiSubnetIpConfigurationResponse[];
/**
* The name of the resource
*/
readonly name: string;
/**
* Listener port.
*/
readonly port?: number;
/**
* Provisioning state to track the async operation status.
*/
readonly provisioningState: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.sqlvirtualmachine.SystemDataResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Gets an availability group listener.
*
* Uses Azure REST API version 2023-10-01.
*
* Other available API versions: 2022-02-01, 2022-07-01-preview, 2022-08-01-preview, 2023-01-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native sqlvirtualmachine [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getAvailabilityGroupListenerOutput(args: GetAvailabilityGroupListenerOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAvailabilityGroupListenerResult>;
export interface GetAvailabilityGroupListenerOutputArgs {
/**
* Name of the availability group listener.
*/
availabilityGroupListenerName: pulumi.Input<string>;
/**
* The child resources to include in the response.
*/
expand?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Name of the SQL virtual machine group.
*/
sqlVirtualMachineGroupName: pulumi.Input<string>;
}