Share via

WCF Relays - List By Namespace

Service:
Relay
API Version:
2024-01-01

Lists the WCF relays within the namespace.

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

URI Parameters

Name In Required Type Description
namespaceName
 path True

string

minLength: 6
maxLength: 50

The namespace name
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string

minLength: 1

The ID of the target subscription.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

WcfRelaysListResult

The request has succeeded.
Other Status Codes

ErrorResponse

An unexpected error response.

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

RelayListAll

Sample request

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

Sample response

Status code:
200 
{
  "value": [
    {
      "name": "example-Relay-Wcf-01",
      "type": "Microsoft.Relay/Namespaces/WcfRelays",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/WcfRelays/example-Relay-Wcf-01",
      "properties": {
        "createdAt": "2017-01-24T00:46:27.0049983Z",
        "isDynamic": false,
        "relayType": "NetTcp",
        "requiresClientAuthorization": true,
        "requiresTransportSecurity": true,
        "updatedAt": "2017-01-24T00:46:27.0049983Z",
        "userMetadata": "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. 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"
      }
    }
  ]
}

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.
WcfRelaysListResult

The response of the list WCF relay operation.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

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

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

Relaytype

Enumeration

WCF relay type.

Value Description
NetTcp
Http

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

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 (date-time)

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

Object

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 (date-time)

The time the WCF relay was created.
properties.isDynamic

boolean

Returns true if the relay is dynamic; otherwise, false.
properties.listenerCount

integer (int32)

maximum: 25

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 (date-time)

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

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

WcfRelaysListResult

Object

The response of the list WCF relay operation.

Name Type Description
nextLink

string (uri)

The link to the next page of items
value

WcfRelay[]

The WcfRelay items on this page