Microsoft.Relay (preview:2018-01-01)

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

Operations_List (new)
Description :  Lists all available Relay REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Relay/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Relay operations supported by resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Relay. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CheckNameAvailability (new)
Description :  Check the specified namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability
{
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 ,
parameters:
{
Description: Parameters to check availability of the specified namespace name. ,
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)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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: 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 namespace operation. ,
Required: False ,
}
[
{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListByResourceGroup (new)
Description :  Lists all the available namespaces within the ResourceGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
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 namespace operation. ,
Required: False ,
}
[
{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdate (new)
Description :  Create Azure Relay namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create 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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
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)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (201)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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}
{
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)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_Get (new)
Description :  Returns the description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
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)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
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)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (201)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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
{
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 ,
parameters:
{
Description: The Namespace IpFilterRule. ,
Required: True ,
}
{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: 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 ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: 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)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_GetNetworkRuleSet (new)
Description :  Gets NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/networkRuleSets/default
{
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)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: 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)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_ListByNamespace (new)
Description :  Lists all Private Endpoint Connections for the Relay namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections
{
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: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Put (new)
Description :  Updates the specified private endpoint connection associated with the Relay namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name. ,
Required: True ,
}
string ,
parameters:
{
Description: The intended state of private endpoint connection. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes the specified private endpoint connection associated with the relay namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection 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 (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the specified private endpoint connection associated with the Relay Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection 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: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
OperationStatusPrivateEndpointConnections_Get (new)
Description :  Gets the Operation status of private endpoint connection associated with Relay namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}/operationStatus/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
operationType:
{
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)

{
id:
{
Description: Full identifier of the private endpoint connection resource. ,
Required: False ,
}
string ,
name:
{
Description: name of the private endpoint connection resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of private endpoint connection operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateLinkResourcesGet (new)
Description :  Gets the private link resources supported for the Relay namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources
{
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: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: Group identifier of private link resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Required member names of private link resource. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names of the the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Lists all available Relay REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Relay/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Relay operations supported by resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Relay. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CheckNameAvailability (removed)
Description :  Check the specified namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability
{
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 ,
parameters:
{
Description: Parameters to check availability of the specified namespace name. ,
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)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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: 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 namespace operation. ,
Required: False ,
}
[
{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListByResourceGroup (removed)
Description :  Lists all the available namespaces within the ResourceGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
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 namespace operation. ,
Required: False ,
}
[
{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_CreateOrUpdate (removed)
Description :  Create Azure Relay namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create 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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
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)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (201)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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}
{
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)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_Get (removed)
Description :  Returns the description for the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}
{
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)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
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)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (201)

{
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:
{
Enum:
{
Created: No description available. ,
Succeeded: No description available. ,
Deleted: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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
{
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 ,
parameters:
{
Description: The Namespace IpFilterRule. ,
Required: True ,
}
{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: 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 ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: 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)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_GetNetworkRuleSet (removed)
Description :  Gets NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/networkRuleSets/default
{
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)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: 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)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_ListByNamespace (removed)
Description :  Lists all Private Endpoint Connections for the Relay namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections
{
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: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Put (removed)
Description :  Updates the specified private endpoint connection associated with the Relay namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name. ,
Required: True ,
}
string ,
parameters:
{
Description: The intended state of private endpoint connection. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Delete (removed)
Description :  Deletes the specified private endpoint connection associated with the relay namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection 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 (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Get (removed)
Description :  Gets the specified private endpoint connection associated with the Relay Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection 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: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Properties of the private endpoint object. ,
Required: False ,
}
{
id:
{
Description: Full identifier of the private endpoint resource. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Approval state of the private link connection. ,
Required: False ,
}
{
status:
{
Description: Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval or rejection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
UpdatingByProxy: No description available. ,
Deleting: No description available. ,
DeletingByProxy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
OperationStatusPrivateEndpointConnections_Get (removed)
Description :  Gets the Operation status of private endpoint connection associated with Relay namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}/operationStatus/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
operationType:
{
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)

{
id:
{
Description: Full identifier of the private endpoint connection resource. ,
Required: False ,
}
string ,
name:
{
Description: name of the private endpoint connection resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of private endpoint connection operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateLinkResourcesGet (removed)
Description :  Gets the private link resources supported for the Relay namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources
{
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: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: Group identifier of private link resource. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: Required member names of private link resource. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names of the the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}