Microsoft.EventHub (stable:2017-04-01)

2025/10/30 • 43 new, 43 deleted methods

Namespaces_ListAuthorizationRules (new)
Description :  Gets a list of authorization rules for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules
{
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 that uniquely identify a 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 Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules ,
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_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an AuthorizationRule for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access AuthorizationRule. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_DeleteAuthorizationRule (new)
Description :  Deletes an AuthorizationRule for a Namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_GetAuthorizationRule (new)
Description :  Gets an AuthorizationRule for a Namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListKeys (new)
Description :  Gets the primary and secondary connection strings for the Namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
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_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings for the specified Namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to regenerate the connection string. ,
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 provided, is set for KeyType or autogenerated Key value set for keyType ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_ListAuthorizationRules (new)
Description :  Gets a list of authorization rules for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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 Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_GetAuthorizationRule (new)
Description :  Gets an AuthorizationRule for a Namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_ListKeys (new)
Description :  Gets the primary and secondary connection strings for the Namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_ListAuthorizationRules (new)
Description :  Gets the authorization rules for an Event Hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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 Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access AuthorizationRule. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_GetAuthorizationRule (new)
Description :  Gets an AuthorizationRule for an Event Hub by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_DeleteAuthorizationRule (new)
Description :  Deletes an Event Hub AuthorizationRule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_ListKeys (new)
Description :  Gets the ACS and SAS connection strings for the Event Hub.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_RegenerateKeys (new)
Description :  Regenerates the ACS and SAS connection strings for the Event Hub.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey). ,
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 provided, is set for KeyType or autogenerated Key value set for keyType ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
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 give Namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/checkNameAvailability
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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 given Namespace name ,
Required: True ,
}
{
name:
{
Description: Name to check the namespace name availability ,
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 availability, 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 ,
}
ConsumerGroups_CreateOrUpdate (new)
Description :  Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
consumerGroupName:
{
Description: The consumer group name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update a consumer group resource. ,
Required: True ,
}
{
properties:
{
Description: Single item in List or Get Consumer group operation ,
Required: False ,
}
{
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
userMetadata:
{
Description: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Single item in List or Get Consumer group operation ,
Required: False ,
}
{
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
userMetadata:
{
Description: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConsumerGroups_Delete (new)
Description :  Deletes a consumer group from the specified Event Hub and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
consumerGroupName:
{
Description: The consumer group name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConsumerGroups_Get (new)
Description :  Gets a description for the specified consumer group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
consumerGroupName:
{
Description: The consumer group name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Single item in List or Get Consumer group operation ,
Required: False ,
}
{
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
userMetadata:
{
Description: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConsumerGroups_ListByEventHub (new)
Description :  Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Consumer Group operation. ,
Required: False ,
}
[
{
properties:
{
Description: Single item in List or Get Consumer group operation ,
Required: False ,
}
{
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
userMetadata:
{
Description: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Consumer Group ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/checkNameAvailability
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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 ,
parameters:
{
Description: Parameters to check availability of the given Alias name ,
Required: True ,
}
{
name:
{
Description: Name to check the namespace name availability ,
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 availability, 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 ,
}
DisasterRecoveryConfigs_List (new)
Description :  Gets all Alias(Disaster Recovery configurations)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs
{
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 that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Alias(Disaster Recovery configurations) ,
Required: False ,
}
[
{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration) ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_CreateOrUpdate (new)
Description :  Creates or updates a new Alias(Disaster Recovery configuration)
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to create an Alias(Disaster Recovery configuration) ,
Required: True ,
}
{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_Delete (new)
Description :  Deletes an Alias(Disaster Recovery configuration)
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_Get (new)
Description :  Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_BreakPairing (new)
Description :  This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_FailOver (new)
Description :  Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_ListByNamespace (new)
Description :  Gets all the Event Hubs in a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs
{
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 that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List EventHubs operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of EventHubs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_CreateOrUpdate (new)
Description :  Creates or updates a new Event Hub as a nested resource within a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create an Event Hub resource. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_Delete (new)
Description :  Deletes an Event Hub from the specified Namespace and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_Get (new)
Description :  Gets an Event Hubs description for the specified Event Hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 a subscription, irrespective of the resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
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 the available Namespaces within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/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 that uniquely identify a 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: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
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 :  Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/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 creating a namespace resource. ,
Required: True ,
}
{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ 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.EventHub/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 that uniquely identify a 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 :  Gets the description of the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/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 that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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.EventHub/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: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_GetMessagingPlan (new)
Description :  Gets messaging plan for specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/messagingplan
{
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 that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
sku:
{
Description: Sku type ,
Format: int32 ,
Required: False ,
}
integer ,
selectedEventHubUnit:
{
Description: Selected event hub unit ,
Format: int32 ,
Required: False ,
}
integer ,
updatedAt:
{
Description: The exact time the messaging plan was updated. ,
Format: date-time ,
Required: False ,
}
string ,
revision:
{
Description: revision number ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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.EventHub/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 that uniquely identify a 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 ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
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 ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
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.EventHub/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 that uniquely identify a 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 ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
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_ListNetworkRuleSets (new)
Description :  Gets list of NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets
{
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 that uniquely identify a 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 NetworkRuleSet operation. ,
Required: False ,
}
[
{
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 ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet. ,
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 (new)
Description :  Lists all of the available Event Hub REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Event Hub operations supported by the Microsoft.EventHub 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: Microsoft.EventHub ,
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 ,
}
Regions_ListBySku (new)
Description :  Gets the available Regions for a given sku
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/sku/{sku}/regions
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
sku:
{
Description: The sku type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List MessagingRegions type. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Messaging Region ,
Required: False ,
}
{
code:
{
Description: Region code ,
Required: False ,
}
string ,
fullName:
{
Description: Full name of the region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of MessagingRegions. ,
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_ListAuthorizationRules (removed)
Description :  Gets a list of authorization rules for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules
{
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 that uniquely identify a 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 Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules ,
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_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an AuthorizationRule for a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access AuthorizationRule. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_DeleteAuthorizationRule (removed)
Description :  Deletes an AuthorizationRule for a Namespace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_GetAuthorizationRule (removed)
Description :  Gets an AuthorizationRule for a Namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_ListKeys (removed)
Description :  Gets the primary and secondary connection strings for the Namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
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_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings for the specified Namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to regenerate the connection string. ,
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 provided, is set for KeyType or autogenerated Key value set for keyType ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_ListAuthorizationRules (removed)
Description :  Gets a list of authorization rules for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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 Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_GetAuthorizationRule (removed)
Description :  Gets an AuthorizationRule for a Namespace by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_ListKeys (removed)
Description :  Gets the primary and secondary connection strings for the Namespace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_ListAuthorizationRules (removed)
Description :  Gets the authorization rules for an Event Hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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 Authorization Rules operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The shared access AuthorizationRule. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_GetAuthorizationRule (removed)
Description :  Gets an AuthorizationRule for an Event Hub by rule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_DeleteAuthorizationRule (removed)
Description :  Deletes an Event Hub AuthorizationRule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_ListKeys (removed)
Description :  Gets the ACS and SAS connection strings for the Event Hub.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/listKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_RegenerateKeys (removed)
Description :  Regenerates the ACS and SAS connection strings for the Event Hub.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
authorizationRuleName:
{
Description: The authorization rule name. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey). ,
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 provided, is set for KeyType or autogenerated Key value set for keyType ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryConnectionString:
{
Description: Primary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: Secondary connection string of the created namespace AuthorizationRule. ,
Required: False ,
}
string ,
aliasPrimaryConnectionString:
{
Description: Primary connection string of the alias if GEO DR is enabled ,
Required: False ,
}
string ,
aliasSecondaryConnectionString:
{
Description: Secondary connection string of the alias if GEO DR is enabled ,
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 primary key for signing and validating the SAS token. ,
Required: False ,
}
string ,
keyName:
{
Description: A string that describes the AuthorizationRule. ,
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 give Namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/checkNameAvailability
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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 given Namespace name ,
Required: True ,
}
{
name:
{
Description: Name to check the namespace name availability ,
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 availability, 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 ,
}
ConsumerGroups_CreateOrUpdate (removed)
Description :  Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
consumerGroupName:
{
Description: The consumer group name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create or update a consumer group resource. ,
Required: True ,
}
{
properties:
{
Description: Single item in List or Get Consumer group operation ,
Required: False ,
}
{
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
userMetadata:
{
Description: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Single item in List or Get Consumer group operation ,
Required: False ,
}
{
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
userMetadata:
{
Description: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConsumerGroups_Delete (removed)
Description :  Deletes a consumer group from the specified Event Hub and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
consumerGroupName:
{
Description: The consumer group name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConsumerGroups_Get (removed)
Description :  Gets a description for the specified consumer group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
consumerGroupName:
{
Description: The consumer group name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Single item in List or Get Consumer group operation ,
Required: False ,
}
{
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
userMetadata:
{
Description: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConsumerGroups_ListByEventHub (removed)
Description :  Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Consumer Group operation. ,
Required: False ,
}
[
{
properties:
{
Description: Single item in List or Get Consumer group operation ,
Required: False ,
}
{
createdAt:
{
Description: Exact time the message was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
userMetadata:
{
Description: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Consumer Group ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/checkNameAvailability
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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 ,
parameters:
{
Description: Parameters to check availability of the given Alias name ,
Required: True ,
}
{
name:
{
Description: Name to check the namespace name availability ,
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 availability, 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 ,
}
DisasterRecoveryConfigs_List (removed)
Description :  Gets all Alias(Disaster Recovery configurations)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs
{
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 that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Alias(Disaster Recovery configurations) ,
Required: False ,
}
[
{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration) ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_CreateOrUpdate (removed)
Description :  Creates or updates a new Alias(Disaster Recovery configuration)
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters required to create an Alias(Disaster Recovery configuration) ,
Required: True ,
}
{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_Delete (removed)
Description :  Deletes an Alias(Disaster Recovery configuration)
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_Get (removed)
Description :  Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties required to the Create Or Update Alias(Disaster Recovery configurations) ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
partnerNamespace:
{
Description: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing ,
Required: False ,
}
string ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
role:
{
Description: role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' ,
Enum:
{
Primary: No description available. ,
PrimaryNotReplicating: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
pendingReplicationOperationsCount:
{
Description: Number of entities pending to be replicated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_BreakPairing (removed)
Description :  This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DisasterRecoveryConfigs_FailOver (removed)
Description :  Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
alias:
{
Description: The Disaster Recovery configuration name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_ListByNamespace (removed)
Description :  Gets all the Event Hubs in a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs
{
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 that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
$skip:
{
Description: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
integer ,
$top:
{
Description: May be used to limit the number of results to the most recent N usageDetails. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List EventHubs operation. ,
Required: False ,
}
[
{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of EventHubs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_CreateOrUpdate (removed)
Description :  Creates or updates a new Event Hub as a nested resource within a Namespace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create an Event Hub resource. ,
Required: True ,
}
{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_Delete (removed)
Description :  Deletes an Event Hub from the specified Namespace and resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EventHubs_Get (removed)
Description :  Gets an Event Hubs description for the specified Event Hub.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
eventHubName:
{
Description: The Event Hub name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties supplied to the Create Or Update Event Hub operation. ,
Required: False ,
}
{
partitionIds:
{
Description: Current number of shards on the Event Hub. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Exact time the Event Hub was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The exact time the message was updated. ,
Format: date-time ,
Required: False ,
}
string ,
messageRetentionInDays:
{
Description: Number of days to retain the events for this Event Hub, value should be 1 to 7 days ,
Format: int64 ,
Required: False ,
}
integer ,
partitionCount:
{
Description: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Enumerates the possible values for the status of the Event Hub. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Restoring: No description available. ,
SendDisabled: No description available. ,
ReceiveDisabled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Renaming: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
captureDescription:
{
Description: Properties of capture description ,
Required: False ,
}
{
enabled:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
boolean ,
encoding:
{
Description: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version ,
Enum:
{
Avro: No description available. ,
AvroDeflate: No description available. ,
}
,
Required: False ,
}
enum ,
intervalInSeconds:
{
Description: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds ,
Format: int32 ,
Required: False ,
}
integer ,
sizeLimitInBytes:
{
Description: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes ,
Format: int32 ,
Required: False ,
}
integer ,
destination:
{
Description: Properties of Destination where capture will be stored. (Storage Account, Blob Names) ,
Required: False ,
}
{
name:
{
Description: Name for capture destination ,
Required: False ,
}
string ,
properties:
{
Description: Properties describing the storage account, blob container and archive name format for capture destination ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Resource id of the storage account to be used to create the blobs ,
Required: False ,
}
string ,
blobContainer:
{
Description: Blob container Name ,
Required: False ,
}
string ,
archiveNameFormat:
{
Description: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 a subscription, irrespective of the resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a 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: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
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 the available Namespaces within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/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 that uniquely identify a 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: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
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 :  Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/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 creating a namespace resource. ,
Required: True ,
}
{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ 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.EventHub/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 that uniquely identify a 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 :  Gets the description of the specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/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 that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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.EventHub/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: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units, value should be 0 to 20 throughput units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state 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 ,
isAutoInflateEnabled:
{
Description: Value that indicates whether AutoInflate is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
maximumThroughputUnits:
{
Description: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) ,
Format: int32 ,
Required: False ,
}
integer ,
kafkaEnabled:
{
Description: Value that indicates whether Kafka is enabled for eventhub namespace. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Namespaces_GetMessagingPlan (removed)
Description :  Gets messaging plan for specified namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/messagingplan
{
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 that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
sku:
{
Description: Sku type ,
Format: int32 ,
Required: False ,
}
integer ,
selectedEventHubUnit:
{
Description: Selected event hub unit ,
Format: int32 ,
Required: False ,
}
integer ,
updatedAt:
{
Description: The exact time the messaging plan was updated. ,
Format: date-time ,
Required: False ,
}
string ,
revision:
{
Description: revision number ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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.EventHub/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 that uniquely identify a 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 ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
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 ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
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.EventHub/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 that uniquely identify a 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 ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
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_ListNetworkRuleSets (removed)
Description :  Gets list of NetworkRuleSet for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets
{
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 that uniquely identify a 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 NetworkRuleSet operation. ,
Required: False ,
}
[
{
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 ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: True ,
}
string ,
}
,
ignoreMissingVnetServiceEndpoint:
{
Description: Value that indicates whether to ignore missing VNet Service Endpoint ,
Required: False ,
}
boolean ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet. ,
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 of the available Event Hub REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Event Hub operations supported by the Microsoft.EventHub 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: Microsoft.EventHub ,
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 ,
}
Regions_ListBySku (removed)
Description :  Gets the available Regions for a given sku
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/sku/{sku}/regions
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
sku:
{
Description: The sku type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List MessagingRegions type. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of Messaging Region ,
Required: False ,
}
{
code:
{
Description: Region code ,
Required: False ,
}
string ,
fullName:
{
Description: Full name of the region ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of MessagingRegions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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