1. Packages
  2. Azure Native v2
  3. API Docs
  4. fluidrelay
  5. getFluidRelayServer
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.fluidrelay.getFluidRelayServer

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

A FluidRelay Server. Azure REST API version: 2022-06-01.

Other available API versions: 2021-06-15-preview.

Using getFluidRelayServer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFluidRelayServer(args: GetFluidRelayServerArgs, opts?: InvokeOptions): Promise<GetFluidRelayServerResult>
function getFluidRelayServerOutput(args: GetFluidRelayServerOutputArgs, opts?: InvokeOptions): Output<GetFluidRelayServerResult>
Copy
def get_fluid_relay_server(fluid_relay_server_name: Optional[str] = None,
                           resource_group: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetFluidRelayServerResult
def get_fluid_relay_server_output(fluid_relay_server_name: Optional[pulumi.Input[str]] = None,
                           resource_group: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetFluidRelayServerResult]
Copy
func LookupFluidRelayServer(ctx *Context, args *LookupFluidRelayServerArgs, opts ...InvokeOption) (*LookupFluidRelayServerResult, error)
func LookupFluidRelayServerOutput(ctx *Context, args *LookupFluidRelayServerOutputArgs, opts ...InvokeOption) LookupFluidRelayServerResultOutput
Copy

> Note: This function is named LookupFluidRelayServer in the Go SDK.

public static class GetFluidRelayServer 
{
    public static Task<GetFluidRelayServerResult> InvokeAsync(GetFluidRelayServerArgs args, InvokeOptions? opts = null)
    public static Output<GetFluidRelayServerResult> Invoke(GetFluidRelayServerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFluidRelayServerResult> getFluidRelayServer(GetFluidRelayServerArgs args, InvokeOptions options)
public static Output<GetFluidRelayServerResult> getFluidRelayServer(GetFluidRelayServerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:fluidrelay:getFluidRelayServer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FluidRelayServerName
This property is required.
Changes to this property will trigger replacement.
string
The Fluid Relay server resource name.
ResourceGroup
This property is required.
Changes to this property will trigger replacement.
string
The resource group containing the resource.
FluidRelayServerName
This property is required.
Changes to this property will trigger replacement.
string
The Fluid Relay server resource name.
ResourceGroup
This property is required.
Changes to this property will trigger replacement.
string
The resource group containing the resource.
fluidRelayServerName
This property is required.
Changes to this property will trigger replacement.
String
The Fluid Relay server resource name.
resourceGroup
This property is required.
Changes to this property will trigger replacement.
String
The resource group containing the resource.
fluidRelayServerName
This property is required.
Changes to this property will trigger replacement.
string
The Fluid Relay server resource name.
resourceGroup
This property is required.
Changes to this property will trigger replacement.
string
The resource group containing the resource.
fluid_relay_server_name
This property is required.
Changes to this property will trigger replacement.
str
The Fluid Relay server resource name.
resource_group
This property is required.
Changes to this property will trigger replacement.
str
The resource group containing the resource.
fluidRelayServerName
This property is required.
Changes to this property will trigger replacement.
String
The Fluid Relay server resource name.
resourceGroup
This property is required.
Changes to this property will trigger replacement.
String
The resource group containing the resource.

getFluidRelayServer Result

The following output properties are available:

FluidRelayEndpoints Pulumi.AzureNative.FluidRelay.Outputs.FluidRelayEndpointsResponse
The Fluid Relay Service endpoints for this server.
FrsTenantId string
The Fluid tenantId for this server
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData Pulumi.AzureNative.FluidRelay.Outputs.SystemDataResponse
System meta data for this resource, including creation and modification information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Encryption Pulumi.AzureNative.FluidRelay.Outputs.EncryptionPropertiesResponse
All encryption configuration for a resource.
Identity Pulumi.AzureNative.FluidRelay.Outputs.IdentityResponse
The type of identity used for the resource.
ProvisioningState string
Provision states for FluidRelay RP
Storagesku string
Sku of the storage associated with the resource
Tags Dictionary<string, string>
Resource tags.
FluidRelayEndpoints FluidRelayEndpointsResponse
The Fluid Relay Service endpoints for this server.
FrsTenantId string
The Fluid tenantId for this server
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData SystemDataResponse
System meta data for this resource, including creation and modification information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Encryption EncryptionPropertiesResponse
All encryption configuration for a resource.
Identity IdentityResponse
The type of identity used for the resource.
ProvisioningState string
Provision states for FluidRelay RP
Storagesku string
Sku of the storage associated with the resource
Tags map[string]string
Resource tags.
fluidRelayEndpoints FluidRelayEndpointsResponse
The Fluid Relay Service endpoints for this server.
frsTenantId String
The Fluid tenantId for this server
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
systemData SystemDataResponse
System meta data for this resource, including creation and modification information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
encryption EncryptionPropertiesResponse
All encryption configuration for a resource.
identity IdentityResponse
The type of identity used for the resource.
provisioningState String
Provision states for FluidRelay RP
storagesku String
Sku of the storage associated with the resource
tags Map<String,String>
Resource tags.
fluidRelayEndpoints FluidRelayEndpointsResponse
The Fluid Relay Service endpoints for this server.
frsTenantId string
The Fluid tenantId for this server
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
systemData SystemDataResponse
System meta data for this resource, including creation and modification information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
encryption EncryptionPropertiesResponse
All encryption configuration for a resource.
identity IdentityResponse
The type of identity used for the resource.
provisioningState string
Provision states for FluidRelay RP
storagesku string
Sku of the storage associated with the resource
tags {[key: string]: string}
Resource tags.
fluid_relay_endpoints FluidRelayEndpointsResponse
The Fluid Relay Service endpoints for this server.
frs_tenant_id str
The Fluid tenantId for this server
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
system_data SystemDataResponse
System meta data for this resource, including creation and modification information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
encryption EncryptionPropertiesResponse
All encryption configuration for a resource.
identity IdentityResponse
The type of identity used for the resource.
provisioning_state str
Provision states for FluidRelay RP
storagesku str
Sku of the storage associated with the resource
tags Mapping[str, str]
Resource tags.
fluidRelayEndpoints Property Map
The Fluid Relay Service endpoints for this server.
frsTenantId String
The Fluid tenantId for this server
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
systemData Property Map
System meta data for this resource, including creation and modification information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
encryption Property Map
All encryption configuration for a resource.
identity Property Map
The type of identity used for the resource.
provisioningState String
Provision states for FluidRelay RP
storagesku String
Sku of the storage associated with the resource
tags Map<String>
Resource tags.

Supporting Types

CustomerManagedKeyEncryptionPropertiesResponse

KeyEncryptionKeyIdentity Pulumi.AzureNative.FluidRelay.Inputs.CustomerManagedKeyEncryptionPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
KeyEncryptionKeyUrl string
key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.
KeyEncryptionKeyIdentity CustomerManagedKeyEncryptionPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
KeyEncryptionKeyUrl string
key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.
keyEncryptionKeyIdentity CustomerManagedKeyEncryptionPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
keyEncryptionKeyUrl String
key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.
keyEncryptionKeyIdentity CustomerManagedKeyEncryptionPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
keyEncryptionKeyUrl string
key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.
key_encryption_key_identity CustomerManagedKeyEncryptionPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
key_encryption_key_url str
key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.
keyEncryptionKeyIdentity Property Map
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
keyEncryptionKeyUrl String
key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.

CustomerManagedKeyEncryptionPropertiesResponseKeyEncryptionKeyIdentity

IdentityType string
Values can be SystemAssigned or UserAssigned
UserAssignedIdentityResourceId string
user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity.
IdentityType string
Values can be SystemAssigned or UserAssigned
UserAssignedIdentityResourceId string
user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity.
identityType String
Values can be SystemAssigned or UserAssigned
userAssignedIdentityResourceId String
user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity.
identityType string
Values can be SystemAssigned or UserAssigned
userAssignedIdentityResourceId string
user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity.
identity_type str
Values can be SystemAssigned or UserAssigned
user_assigned_identity_resource_id str
user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity.
identityType String
Values can be SystemAssigned or UserAssigned
userAssignedIdentityResourceId String
user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity.

EncryptionPropertiesResponse

CustomerManagedKeyEncryption CustomerManagedKeyEncryptionPropertiesResponse
All Customer-managed key encryption properties for the resource.
customerManagedKeyEncryption CustomerManagedKeyEncryptionPropertiesResponse
All Customer-managed key encryption properties for the resource.
customerManagedKeyEncryption CustomerManagedKeyEncryptionPropertiesResponse
All Customer-managed key encryption properties for the resource.
customer_managed_key_encryption CustomerManagedKeyEncryptionPropertiesResponse
All Customer-managed key encryption properties for the resource.
customerManagedKeyEncryption Property Map
All Customer-managed key encryption properties for the resource.

FluidRelayEndpointsResponse

OrdererEndpoints This property is required. List<string>
The Fluid Relay Orderer endpoints.
ServiceEndpoints This property is required. List<string>
The Fluid Relay service endpoints.
StorageEndpoints This property is required. List<string>
The Fluid Relay storage endpoints.
OrdererEndpoints This property is required. []string
The Fluid Relay Orderer endpoints.
ServiceEndpoints This property is required. []string
The Fluid Relay service endpoints.
StorageEndpoints This property is required. []string
The Fluid Relay storage endpoints.
ordererEndpoints This property is required. List<String>
The Fluid Relay Orderer endpoints.
serviceEndpoints This property is required. List<String>
The Fluid Relay service endpoints.
storageEndpoints This property is required. List<String>
The Fluid Relay storage endpoints.
ordererEndpoints This property is required. string[]
The Fluid Relay Orderer endpoints.
serviceEndpoints This property is required. string[]
The Fluid Relay service endpoints.
storageEndpoints This property is required. string[]
The Fluid Relay storage endpoints.
orderer_endpoints This property is required. Sequence[str]
The Fluid Relay Orderer endpoints.
service_endpoints This property is required. Sequence[str]
The Fluid Relay service endpoints.
storage_endpoints This property is required. Sequence[str]
The Fluid Relay storage endpoints.
ordererEndpoints This property is required. List<String>
The Fluid Relay Orderer endpoints.
serviceEndpoints This property is required. List<String>
The Fluid Relay service endpoints.
storageEndpoints This property is required. List<String>
The Fluid Relay storage endpoints.

IdentityResponse

PrincipalId This property is required. string
The principal ID of resource identity.
TenantId This property is required. string
The tenant ID of resource.
Type string
The identity type.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.FluidRelay.Inputs.IdentityResponseUserAssignedIdentities>
The list of user identities associated with the resource.
PrincipalId This property is required. string
The principal ID of resource identity.
TenantId This property is required. string
The tenant ID of resource.
Type string
The identity type.
UserAssignedIdentities map[string]IdentityResponseUserAssignedIdentities
The list of user identities associated with the resource.
principalId This property is required. String
The principal ID of resource identity.
tenantId This property is required. String
The tenant ID of resource.
type String
The identity type.
userAssignedIdentities Map<String,IdentityResponseUserAssignedIdentities>
The list of user identities associated with the resource.
principalId This property is required. string
The principal ID of resource identity.
tenantId This property is required. string
The tenant ID of resource.
type string
The identity type.
userAssignedIdentities {[key: string]: IdentityResponseUserAssignedIdentities}
The list of user identities associated with the resource.
principal_id This property is required. str
The principal ID of resource identity.
tenant_id This property is required. str
The tenant ID of resource.
type str
The identity type.
user_assigned_identities Mapping[str, IdentityResponseUserAssignedIdentities]
The list of user identities associated with the resource.
principalId This property is required. String
The principal ID of resource identity.
tenantId This property is required. String
The tenant ID of resource.
type String
The identity type.
userAssignedIdentities Map<Property Map>
The list of user identities associated with the resource.

IdentityResponseUserAssignedIdentities

ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.
clientId This property is required. string
The client id of user assigned identity.
principalId This property is required. string
The principal id of user assigned identity.
client_id This property is required. str
The client id of user assigned identity.
principal_id This property is required. str
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi