WCF Relays - Create Or Update

Service:

Relay

API Version:

2024-01-01

Creates or updates a WCF relay. This operation is idempotent.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}?api-version=2024-01-01

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string	The namespace name
relayName	path	True	string	The relay name.
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription.
subscriptionId	path	True	string	Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Request Body

Name	Type	Description
properties.relayType	Relaytype	WCF relay type.
properties.requiresClientAuthorization	boolean	Returns true if client authorization is needed for this relay; otherwise, false.
properties.requiresTransportSecurity	boolean	Returns true if transport security is needed for this relay; otherwise, false.
properties.userMetadata	string	The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.

Responses

Name	Type	Description
200 OK	WcfRelay	Request to create WCF relay succeeded.
Other Status Codes	ErrorResponse	Relay error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

RelayCreate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-9953/wcfRelays/example-Relay-Wcf-1194?api-version=2024-01-01

{
  "properties": {
    "relayType": "NetTcp",
    "requiresClientAuthorization": true,
    "requiresTransportSecurity": true
  }
}

Sample response

Status code:

200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-9953/WcfRelays/example-Relay-Wcf-1194",
  "name": "example-Relay-Wcf-1194",
  "type": "Microsoft.Relay/WcfRelays",
  "properties": {
    "createdAt": "2017-03-16T00:26:17.5014661Z",
    "updatedAt": "2017-03-16T00:26:17.5014661Z",
    "relayType": "NetTcp",
    "requiresClientAuthorization": true,
    "requiresTransportSecurity": true,
    "isDynamic": false
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Relaytype	WCF relay type.
systemData	Metadata pertaining to creation and last modification of the resource.
WcfRelay	Description of the WCF relay resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Relaytype

WCF relay type.

Name	Type	Description
Http	string
NetTcp	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	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	createdByType	The type of identity that last modified the resource.

WcfRelay

Description of the WCF relay resource.

Name	Type	Description
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
properties.createdAt	string	The time the WCF relay was created.
properties.isDynamic	boolean	Returns true if the relay is dynamic; otherwise, false.
properties.listenerCount	integer	The number of listeners for this relay. Note that min :1 and max:25 are supported.
properties.relayType	Relaytype	WCF relay type.
properties.requiresClientAuthorization	boolean	Returns true if client authorization is needed for this relay; otherwise, false.
properties.requiresTransportSecurity	boolean	Returns true if transport security is needed for this relay; otherwise, false.
properties.updatedAt	string	The time the namespace was updated.
properties.userMetadata	string	The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
systemData	systemData	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"