@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.29 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get the resource and its properties.
*
* Uses Azure REST API version 2024-03-01.
*
* Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-01-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native signalrservice [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getSignalR(args: GetSignalRArgs, opts?: pulumi.InvokeOptions): Promise<GetSignalRResult>;
export interface GetSignalRArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the resource.
*/
resourceName: string;
}
/**
* A class represent a resource.
*/
export interface GetSignalRResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Cross-Origin Resource Sharing (CORS) settings.
*/
readonly cors?: outputs.signalrservice.SignalRCorsSettingsResponse;
/**
* DisableLocalAuth
* Enable or disable aad auth
* When set as true, connection with AuthType=aad won't work.
*/
readonly disableAadAuth?: boolean;
/**
* DisableLocalAuth
* Enable or disable local auth with AccessKey
* When set as true, connection with AccessKey=xxx won't work.
*/
readonly disableLocalAuth?: boolean;
/**
* The publicly accessible IP of the resource.
*/
readonly externalIP: string;
/**
* List of the featureFlags.
*
* FeatureFlags that are not included in the parameters for the update operation will not be modified.
* And the response will only include featureFlags that are explicitly set.
* When a featureFlag is not explicitly set, its globally default value will be used
* But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.
*/
readonly features?: outputs.signalrservice.SignalRFeatureResponse[];
/**
* FQDN of the service instance.
*/
readonly hostName: string;
/**
* Deprecated.
*/
readonly hostNamePrefix: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* A class represent managed identities used for request and response
*/
readonly identity?: outputs.signalrservice.ManagedIdentityResponse;
/**
* The kind of the service
*/
readonly kind?: string;
/**
* Live trace configuration of a Microsoft.SignalRService resource.
*/
readonly liveTraceConfiguration?: outputs.signalrservice.LiveTraceConfigurationResponse;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Network ACLs for the resource
*/
readonly networkACLs?: outputs.signalrservice.SignalRNetworkACLsResponse;
/**
* Private endpoint connections to the resource.
*/
readonly privateEndpointConnections: outputs.signalrservice.PrivateEndpointConnectionResponse[];
/**
* Provisioning state of the resource.
*/
readonly provisioningState: string;
/**
* Enable or disable public network access. Default to "Enabled".
* When it's Enabled, network ACLs still apply.
* When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
*/
readonly publicNetworkAccess?: string;
/**
* The publicly accessible port of the resource which is designed for browser/client side usage.
*/
readonly publicPort: number;
/**
* Enable or disable the regional endpoint. Default to "Enabled".
* When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.
* This property is replica specific. Disable the regional endpoint without replica is not allowed.
*/
readonly regionEndpointEnabled?: string;
/**
* Resource log configuration of a Microsoft.SignalRService resource.
*/
readonly resourceLogConfiguration?: outputs.signalrservice.ResourceLogConfigurationResponse;
/**
* Stop or start the resource. Default to "False".
* When it's true, the data plane of the resource is shutdown.
* When it's false, the data plane of the resource is started.
*/
readonly resourceStopped?: string;
/**
* The publicly accessible port of the resource which is designed for customer server side usage.
*/
readonly serverPort: number;
/**
* Serverless settings.
*/
readonly serverless?: outputs.signalrservice.ServerlessSettingsResponse;
/**
* The list of shared private link resources.
*/
readonly sharedPrivateLinkResources: outputs.signalrservice.SharedPrivateLinkResourceResponse[];
/**
* The billing information of the resource.
*/
readonly sku?: outputs.signalrservice.ResourceSkuResponse;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.signalrservice.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* TLS settings for the resource
*/
readonly tls?: outputs.signalrservice.SignalRTlsSettingsResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* The settings for the Upstream when the service is in server-less mode.
*/
readonly upstream?: outputs.signalrservice.ServerlessUpstreamSettingsResponse;
/**
* Version of the resource. Probably you need the same or higher version of client SDKs.
*/
readonly version: string;
}
/**
* Get the resource and its properties.
*
* Uses Azure REST API version 2024-03-01.
*
* Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-01-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native signalrservice [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getSignalROutput(args: GetSignalROutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSignalRResult>;
export interface GetSignalROutputArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the resource.
*/
resourceName: pulumi.Input<string>;
}