Microsoft.Relay (stable:2024-01-01)

2025/09/12 • 42 new, 42 deleted methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Relay/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CheckNameAvailability (new)
Description :  Check the specified namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The namespace name to check for availability. The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Value indicating namespace is available. Returns true if the namespace is available; otherwise, false. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability of a namespace. ,
Enum:
{
None: No description available. ,
InvalidName: No description available. ,
SubscriptionIsDisabled: No description available. ,
NameInUse: No description available. ,
NameInLockdown: No description available. ,
TooManyNamespaceInCurrentSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_List (new)
Description :  Lists all the available namespaces within the subscription regardless of the resourceGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/namespaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The RelayNamespace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListByResourceGroup (new)
Description :  Lists all the available namespaces within the ResourceGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The RelayNamespace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Get (new)
Description :  Returns the description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdate (new)
Description :  Create Azure Relay namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a namespace resource. ,
Required: True ,
}
{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Description of a namespace resource. ,
}
{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Update (new)
Description :  Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating a namespace resource. ,
Required: True ,
}
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Delete (new)
Description :  Deletes an existing namespace. This operation also removes all associated resources under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListAuthorizationRules (new)
Description :  Authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AuthorizationRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetAuthorizationRule (new)
Description :  Authorization rule for a namespace by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an authorization rule for a namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_DeleteAuthorizationRule (new)
Description :  Deletes a namespace authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListKeys (new)
Description :  Primary and secondary connection strings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_ListByNamespace (new)
Description :  Lists the hybrid connection within the namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HybridConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_Get (new)
Description :  Returns the description for the specified hybrid connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_CreateOrUpdate (new)
Description :  Creates or updates a service hybrid connection. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a hybrid connection. ,
Required: True ,
}
{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_Delete (new)
Description :  Deletes a hybrid connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_ListAuthorizationRules (new)
Description :  Authorization rules for a hybrid connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AuthorizationRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_GetAuthorizationRule (new)
Description :  Hybrid connection authorization rule for a hybrid connection by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an authorization rule for a hybrid connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_DeleteAuthorizationRule (new)
Description :  Deletes a hybrid connection authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_ListKeys (new)
Description :  Primary and secondary connection strings to the hybrid connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings to the hybrid connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetNetworkRuleSet (new)
Description :  Gets NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/networkRuleSets/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateNetworkRuleSet (new)
Description :  Create or update NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/networkRuleSets/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: The Namespace IpFilterRule. ,
Required: True ,
}
{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  Gets the available PrivateEndpointConnections within a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets a description for the specified Private Endpoint Connection name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Creates or updates PrivateEndpointConnections of service namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes an existing namespace. This operation also removes all associated resources under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_List (new)
Description :  Lists the private link resources for a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of private link resources ,
Required: True ,
}
[
{
properties:
{
Description: A resource that supports private link capabilities. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of private link resources. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets a private link resource by a specified group name for a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources/{privateLinkResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateLinkResourceName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A resource that supports private link capabilities. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_ListByNamespace (new)
Description :  Lists the WCF relays within the namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list WCF relay operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of WCF relays. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_Get (new)
Description :  Returns the description for the specified WCF relay.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_CreateOrUpdate (new)
Description :  Creates or updates a WCF relay. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a WCF relay. ,
Required: True ,
}
{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_Delete (new)
Description :  Deletes a WCF relay.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_ListAuthorizationRules (new)
Description :  Authorization rules for a WCF relay.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AuthorizationRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_GetAuthorizationRule (new)
Description :  Get authorizationRule for a WCF relay by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an authorization rule for a WCF relay.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_DeleteAuthorizationRule (new)
Description :  Deletes a WCF relay authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_ListKeys (new)
Description :  Primary and secondary connection strings to the WCF relay.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings to the WCF relay.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CheckNameAvailability (removed)
Description :  Check the specified namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The namespace name to check for availability. The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: The detailed info regarding the reason associated with the namespace. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Value indicating namespace is available. Returns true if the namespace is available; otherwise, false. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability of a namespace. ,
Enum:
{
None: No description available. ,
InvalidName: No description available. ,
SubscriptionIsDisabled: No description available. ,
NameInUse: No description available. ,
NameInLockdown: No description available. ,
TooManyNamespaceInCurrentSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_List (removed)
Description :  Lists all the available namespaces within the subscription regardless of the resourceGroups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/namespaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The RelayNamespace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListByResourceGroup (removed)
Description :  Lists all the available namespaces within the ResourceGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The RelayNamespace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdate (removed)
Description :  Create Azure Relay namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a namespace resource. ,
Required: True ,
}
{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Description of a namespace resource. ,
}
{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Delete (removed)
Description :  Deletes an existing namespace. This operation also removes all associated resources under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Get (removed)
Description :  Returns the description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Update (removed)
Description :  Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating a namespace resource. ,
Required: True ,
}
{
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Description of Relay namespace. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Description of Relay namespace ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
metricId:
{
Description: Identifier for Azure Insights metrics. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU of the namespace. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The tier of this SKU. ,
Enum:
{
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (removed)
Description :  Gets the available PrivateEndpointConnections within a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Creates or updates PrivateEndpointConnections of service namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Deletes an existing namespace. This operation also removes all associated resources under the namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Gets a description for the specified Private Endpoint Connection name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Gets a private link resource by a specified group name for a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources/{privateLinkResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateLinkResourceName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A resource that supports private link capabilities. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_List (removed)
Description :  Lists the private link resources for a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of private link resources ,
Required: True ,
}
[
{
properties:
{
Description: A resource that supports private link capabilities. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of private link resources. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateNetworkRuleSet (removed)
Description :  Create or update NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/networkRuleSets/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: The Namespace IpFilterRule. ,
Required: True ,
}
{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetNetworkRuleSet (removed)
Description :  Gets NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/networkRuleSets/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: List of IpRules ,
Required: False ,
}
[
{
ipMask:
{
Description: IP Mask ,
Required: False ,
}
string ,
action:
{
Description: The IP Filter Action ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListAuthorizationRules (removed)
Description :  Authorization rules for a namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AuthorizationRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an authorization rule for a namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_DeleteAuthorizationRule (removed)
Description :  Deletes a namespace authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetAuthorizationRule (removed)
Description :  Authorization rule for a namespace by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListKeys (removed)
Description :  Primary and secondary connection strings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings to the namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_ListAuthorizationRules (removed)
Description :  Authorization rules for a hybrid connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AuthorizationRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an authorization rule for a hybrid connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_DeleteAuthorizationRule (removed)
Description :  Deletes a hybrid connection authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_GetAuthorizationRule (removed)
Description :  Hybrid connection authorization rule for a hybrid connection by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_ListKeys (removed)
Description :  Primary and secondary connection strings to the hybrid connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings to the hybrid connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_ListAuthorizationRules (removed)
Description :  Authorization rules for a WCF relay.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AuthorizationRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an authorization rule for a WCF relay.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The authorization rule parameters. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_DeleteAuthorizationRule (removed)
Description :  Deletes a WCF relay authorization rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_GetAuthorizationRule (removed)
Description :  Get authorizationRule for a WCF relay by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_ListKeys (removed)
Description :  Primary and secondary connection strings to the WCF relay.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings to the WCF relay.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate authorization rule. ,
Required: True ,
}
{
keyType:
{
Description: The access key to regenerate. ,
Enum:
{
PrimaryKey: No description available. ,
SecondaryKey: No description available. ,
}
,
Required: True ,
}
enum ,
key:
{
Description: Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace authorization rule. ,
Required: False ,
}
string ,
primaryKey:
{
Description: A base64-encoded 256-bit primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: A base64-encoded 256-bit secondary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the authorization rule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_ListByNamespace (removed)
Description :  Lists the hybrid connection within the namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HybridConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_CreateOrUpdate (removed)
Description :  Creates or updates a service hybrid connection. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a hybrid connection. ,
Required: True ,
}
{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_Delete (removed)
Description :  Deletes a hybrid connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HybridConnections_Get (removed)
Description :  Returns the description for the specified hybrid connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: The hybrid connection name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the HybridConnection. ,
Required: False ,
}
{
createdAt:
{
Description: The time the hybrid connection was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this hybrid connection; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Relay/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_ListByNamespace (removed)
Description :  Lists the WCF relays within the namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the list WCF relay operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of WCF relays. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_CreateOrUpdate (removed)
Description :  Creates or updates a WCF relay. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create a WCF relay. ,
Required: True ,
}
{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_Delete (removed)
Description :  Deletes a WCF relay.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WCFRelays_Get (removed)
Description :  Returns the description for the specified WCF relay.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
relayName:
{
Description: The relay name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the WCF relay. ,
Required: False ,
}
{
isDynamic:
{
Description: Returns true if the relay is dynamic; otherwise, false. ,
Required: False ,
}
boolean ,
createdAt:
{
Description: The time the WCF relay was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
listenerCount:
{
Description: The number of listeners for this relay. Note that min :1 and max:25 are supported. ,
Format: int32 ,
Required: False ,
}
integer ,
relayType:
{
Description: WCF relay type. ,
Enum:
{
NetTcp: No description available. ,
Http: No description available. ,
}
,
Required: False ,
}
enum ,
requiresClientAuthorization:
{
Description: Returns true if client authorization is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
requiresTransportSecurity:
{
Description: Returns true if transport security is needed for this relay; otherwise, false. ,
Required: False ,
}
boolean ,
userMetadata:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}