Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The fluidRelayServers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.FluidRelay/fluidRelayServers resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.FluidRelay/fluidRelayServers@2022-06-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
encryption: {
customerManagedKeyEncryption: {
keyEncryptionKeyIdentity: {
identityType: 'string'
userAssignedIdentityResourceId: 'string'
}
keyEncryptionKeyUrl: 'string'
}
}
provisioningState: 'string'
storagesku: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.FluidRelay/fluidRelayServers
| Name | Description | Value |
|---|---|---|
| identity | The type of identity used for the resource. | Identity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The resource-specific properties for this resource. | FluidRelayServerProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
CustomerManagedKeyEncryptionProperties
| Name | Description | Value |
|---|---|---|
| keyEncryptionKeyIdentity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity |
| keyEncryptionKeyUrl | 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. |
string |
CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity
| Name | Description | Value |
|---|---|---|
| identityType | Values can be SystemAssigned or UserAssigned | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentityResourceId | user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. | string |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| customerManagedKeyEncryption | All Customer-managed key encryption properties for the resource. | CustomerManagedKeyEncryptionProperties |
FluidRelayServerProperties
| Name | Description | Value |
|---|---|---|
| encryption | All encryption configuration for a resource. | EncryptionProperties |
| provisioningState | Provision states for FluidRelay RP | 'Canceled' 'Failed' 'Succeeded' |
| storagesku | Sku of the storage associated with the resource | 'basic' 'standard' |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentitiesValue
| Name | Description | Value |
|---|
ARM template resource definition
The fluidRelayServers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.FluidRelay/fluidRelayServers resource, add the following JSON to your template.
{
"type": "Microsoft.FluidRelay/fluidRelayServers",
"apiVersion": "2022-06-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"encryption": {
"customerManagedKeyEncryption": {
"keyEncryptionKeyIdentity": {
"identityType": "string",
"userAssignedIdentityResourceId": "string"
},
"keyEncryptionKeyUrl": "string"
}
},
"provisioningState": "string",
"storagesku": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.FluidRelay/fluidRelayServers
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-06-01' |
| identity | The type of identity used for the resource. | Identity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The resource-specific properties for this resource. | FluidRelayServerProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.FluidRelay/fluidRelayServers' |
CustomerManagedKeyEncryptionProperties
| Name | Description | Value |
|---|---|---|
| keyEncryptionKeyIdentity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity |
| keyEncryptionKeyUrl | 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. |
string |
CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity
| Name | Description | Value |
|---|---|---|
| identityType | Values can be SystemAssigned or UserAssigned | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentityResourceId | user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. | string |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| customerManagedKeyEncryption | All Customer-managed key encryption properties for the resource. | CustomerManagedKeyEncryptionProperties |
FluidRelayServerProperties
| Name | Description | Value |
|---|---|---|
| encryption | All encryption configuration for a resource. | EncryptionProperties |
| provisioningState | Provision states for FluidRelay RP | 'Canceled' 'Failed' 'Succeeded' |
| storagesku | Sku of the storage associated with the resource | 'basic' 'standard' |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentitiesValue
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The fluidRelayServers resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.FluidRelay/fluidRelayServers resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.FluidRelay/fluidRelayServers@2022-06-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
encryption = {
customerManagedKeyEncryption = {
keyEncryptionKeyIdentity = {
identityType = "string"
userAssignedIdentityResourceId = "string"
}
keyEncryptionKeyUrl = "string"
}
}
provisioningState = "string"
storagesku = "string"
}
}
}
Property Values
Microsoft.FluidRelay/fluidRelayServers
| Name | Description | Value |
|---|---|---|
| identity | The type of identity used for the resource. | Identity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The resource-specific properties for this resource. | FluidRelayServerProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.FluidRelay/fluidRelayServers@2022-06-01" |
CustomerManagedKeyEncryptionProperties
| Name | Description | Value |
|---|---|---|
| keyEncryptionKeyIdentity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity |
| keyEncryptionKeyUrl | 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. |
string |
CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity
| Name | Description | Value |
|---|---|---|
| identityType | Values can be SystemAssigned or UserAssigned | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentityResourceId | user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. | string |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| customerManagedKeyEncryption | All Customer-managed key encryption properties for the resource. | CustomerManagedKeyEncryptionProperties |
FluidRelayServerProperties
| Name | Description | Value |
|---|---|---|
| encryption | All encryption configuration for a resource. | EncryptionProperties |
| provisioningState | Provision states for FluidRelay RP | 'Canceled' 'Failed' 'Succeeded' |
| storagesku | Sku of the storage associated with the resource | 'basic' 'standard' |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentitiesValue
| Name | Description | Value |
|---|